Source code for pcapkit.const.mh.enumerating_algorithm

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Enumerating Algorithms
============================

.. module:: pcapkit.const.mh.enumerating_algorithm

This module contains the constant enumeration for **Enumerating Algorithms**,
which is automatically generated from :class:`pcapkit.vendor.mh.enumerating_algorithm.EnumeratingAlgorithm`.

"""

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




class EnumeratingAlgorithm(EnumRegistry, IntEnum):
    """[EnumeratingAlgorithm] Enumerating Algorithms"""

    #: Reserved (not available for assignment) [:rfc:`4285`]
    Reserved_0 = 0

    #: HMAC_SHA1_SPI [:rfc:`4285`]
    HMAC_SHA1_SPI = 3

    #: Reserved for use by 3GPP2 [:rfc:`4285`]
    Reserved_for_use_by_3GPP2 = 5



    @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') -> 'EnumeratingAlgorithm':
        """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__))
        return cls._unregistered_member(value, 'Unassigned')