Source code for pcapkit.const.arp.hardware

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

.. module:: pcapkit.const.arp.hardware

This module contains the constant enumeration for **Hardware Types**,
which is automatically generated from :class:`pcapkit.vendor.arp.hardware.Hardware`.

"""

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




class Hardware(EnumRegistry, IntEnum):
    """[Hardware] Hardware Types [:rfc:`826`][:rfc:`5494`]"""

    #: Reserved [:rfc:`5494`]
    Reserved_0 = 0

    #: Ethernet (10Mb) [Jon Postel]
    Ethernet = 1

    #: Experimental Ethernet (3Mb) [Jon Postel]
    Experimental_Ethernet = 2

    #: Amateur Radio AX.25 [Philip Koch]
    Amateur_Radio_AX_25 = 3

    #: Proteon ProNET Token Ring [Avri Doria]
    Proteon_ProNET_Token_Ring = 4

    #: Chaos [Gill Pratt]
    Chaos = 5

    #: IEEE 802 Networks [Jon Postel]
    IEEE_802_Networks = 6

    #: ARCNET [:rfc:`1201`]
    ARCNET = 7

    #: Hyperchannel [Jon Postel]
    Hyperchannel = 8

    #: Lanstar [Tom Unger]
    Lanstar = 9

    #: Autonet Short Address [Mike Burrows]
    Autonet_Short_Address = 10

    #: LocalTalk [Joyce K Reynolds]
    LocalTalk = 11

    #: LocalNet (IBM PCNet or SYTEK LocalNET) [Joseph Murdock]
    LocalNet = 12

    #: Ultra link [Rajiv Dhingra]
    Ultra_link = 13

    #: SMDS [George Clapp]
    SMDS = 14

    #: Frame Relay [Andy Malis]
    Frame_Relay = 15

    #: Asynchronous Transmission Mode (ATM) [JXB2]
    Asynchronous_Transmission_Mode_16 = 16

    #: HDLC [Jon Postel]
    HDLC = 17

    #: Fibre Channel [:rfc:`4338`]
    Fibre_Channel = 18

    #: Asynchronous Transmission Mode (ATM) [:rfc:`2225`]
    Asynchronous_Transmission_Mode_19 = 19

    #: Serial Line [Jon Postel]
    Serial_Line = 20

    #: Asynchronous Transmission Mode (ATM) [Mike Burrows]
    Asynchronous_Transmission_Mode_21 = 21

    #: MIL-STD-188-220 [Herb Jensen]
    MIL_STD_188_220 = 22

    #: Metricom [Jonathan Stone]
    Metricom = 23

    #: IEEE 1394.1995 [Myron Hattig]
    IEEE_1394_1995 = 24

    #: MAPOS [Mitsuru Maruyama][:rfc:`2176`]
    MAPOS = 25

    #: Twinaxial [Marion Pitts]
    Twinaxial = 26

    #: EUI-64 [Kenji Fujisawa]
    EUI_64 = 27

    #: HIPARP [Jean Michel Pittet]
    HIPARP = 28

    #: IP and ARP over ISO 7816-3 [Scott Guthery]
    IP_and_ARP_over_ISO_7816_3 = 29

    #: ARPSec [Jerome Etienne]
    ARPSec = 30

    #: IPsec tunnel [:rfc:`3456`]
    IPsec_tunnel = 31

    #: InfiniBand (TM) [:rfc:`4391`]
    InfiniBand = 32

    #: TIA-102 Project 25 Common Air Interface (CAI) [Jeff Anderson,
    #: Telecommunications Industry of America (TIA) TR-8.5 Formulating Group,
    #: <cja015&motorola.com>, June 2004]
    TIA_102_Project_25_Common_Air_Interface = 33

    #: Wiegand Interface [Scott Guthery 2]
    Wiegand_Interface = 34

    #: Pure IP [Inaky Perez-Gonzalez]
    Pure_IP = 35

    #: HW_EXP1 [:rfc:`5494`]
    HW_EXP1 = 36

    #: HFI [Tseng-Hui Lin]
    HFI = 37

    #: Unified Bus (UB) [Wei Pan]
    Unified_Bus = 38

    #: HW_EXP2 [:rfc:`5494`]
    HW_EXP2 = 256

    #: AEthernet [Geoffroy Gramaize]
    AEthernet = 257

    #: Reserved [:rfc:`5494`]
    Reserved_65535 = 65535



    @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 <= 65535):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




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

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 65535):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 39 <= value <= 255:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 258 <= value <= 65534:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)