Source code for pcapkit.const.mh.flow_id_status

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Flow Identification Mobility Option Status Codes
======================================================

.. module:: pcapkit.const.mh.flow_id_status

This module contains the constant enumeration for **Flow Identification Mobility Option Status Codes**,
which is automatically generated from :class:`pcapkit.vendor.mh.flow_id_status.FlowIDStatus`.

"""

from typing import TYPE_CHECKING

from aenum import IntEnum

from pcapkit.corekit.enum import EnumRegistry
from pcapkit.utilities.exceptions import EnumValueError

if TYPE_CHECKING:
    from typing import Any

__all__ = ['FlowIDStatus']




class FlowIDStatus(EnumRegistry, IntEnum):
    """[FlowIDStatus] Flow Identification Mobility Option Status Codes"""

    #: Flow binding successful [:rfc:`6089`]
    Flow_binding_successful = 0

    #: Administratively prohibited [:rfc:`6089`]
    Administratively_prohibited = 128

    #: Flow binding rejected, reason unspecified [:rfc:`6089`]
    Flow_binding_rejected_reason_unspecified = 129

    #: Flow identification mobility option malformed [:rfc:`6089`]
    Flow_identification_mobility_option_malformed = 130

    #: BID not found [:rfc:`6089`]
    BID_not_found = 131

    #: FID not found [:rfc:`6089`]
    FID_not_found = 132

    #: Traffic selector format not supported [:rfc:`6089`]
    Traffic_selector_format_not_supported = 133



    @classmethod
    def _validate_value(cls, value: 'Any') -> 'None':
        """Reject ``value`` unless it passes the range check :meth:`_missing_` makes.

        Overrides :meth:`~pcapkit.corekit.enum.EnumLookup._validate_value`
        with that check and the message it raises, so
        :meth:`~pcapkit.corekit.enum.EnumRegistry.register` refuses exactly the
        values :meth:`~pcapkit.corekit.enum.EnumLookup.get` refuses, in the
        same words (:issue:`1816`).

        Args:
            value: Value about to be looked up or minted.

        Raises:
            EnumValueError: If ``value`` fails that check. A
                :exc:`ValueError`, so an ``except ValueError`` caller is
                unaffected.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




    @classmethod
    def _missing_(cls, value: 'int') -> 'FlowIDStatus':
        """Lookup function used when value is not found.

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 1 <= value <= 127:
            #: Unassigned; available for success codes
            return cls._unregistered_member(value, 'Unassigned_available_for_success_codes')
        if 134 <= value <= 250:
            #: Unassigned; available for reject codes
            return cls._unregistered_member(value, 'Unassigned_available_for_reject_codes')
        if 251 <= value <= 255:
            #: Reserved for Experimental Use [:rfc:`6089`]
            return cls._unregistered_member(value, 'Reserved_for_Experimental_Use')
        return super()._missing_(value)