Source code for pcapkit.const.mh.revocation_status_code

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Binding Revocation Acknowledgement Status Codes
=====================================================

.. module:: pcapkit.const.mh.revocation_status_code

This module contains the constant enumeration for **Binding Revocation Acknowledgement Status Codes**,
which is automatically generated from :class:`pcapkit.vendor.mh.revocation_status_code.RevocationStatusCode`.

"""

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__ = ['RevocationStatusCode']




class RevocationStatusCode(EnumRegistry, IntEnum):
    """[RevocationStatusCode] Binding Revocation Acknowledgement Status Codes"""

    #: success [:rfc:`5846`]
    success = 0

    #: partial success [:rfc:`5846`]
    partial_success = 1

    #: Binding Does NOT Exist [:rfc:`5846`]
    Binding_Does_NOT_Exist = 128

    #: IPv4 Home Address Option Required [:rfc:`5846`]
    IPv4_Home_Address_Option_Required = 129

    #: Global Revocation NOT Authorized [:rfc:`5846`]
    Global_Revocation_NOT_Authorized = 130

    #: Revoked Mobile Nodes Identity Required [:rfc:`5846`]
    Revoked_Mobile_Nodes_Identity_Required = 131

    #: Revocation Failed - MN is Attached [:rfc:`5846`]
    Revocation_Failed_MN_is_Attached = 132

    #: Revocation Trigger NOT Supported [:rfc:`5846`]
    Revocation_Trigger_NOT_Supported = 133

    #: Revocation Function NOT Supported [:rfc:`5846`]
    Revocation_Function_NOT_Supported = 134

    #: Proxy Binding Revocation NOT Supported [:rfc:`5846`]
    Proxy_Binding_Revocation_NOT_Supported = 135



    @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') -> 'RevocationStatusCode':
        """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 2 <= value <= 127:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 136 <= value <= 255:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)