Enum SvcParamKey

pub enum SvcParamKey {
    Mandatory,
    Alpn,
    NoDefaultAlpn,
    Port,
    Ipv4Hint,
    EchConfigList,
    Ipv6Hint,
    Key(u16),
    Key65535,
    Unknown(u16),
}

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

14.3.2.  Initial Contents

   The "Service Parameter Keys (SvcParamKeys)" registry has been
   populated with the following initial registrations:

   +===========+=================+================+=========+==========+
   |   Number  | Name            | Meaning        |Reference|Change    |
   |           |                 |                |         |Controller|
   +===========+=================+================+=========+==========+
   |     0     | mandatory       | Mandatory      |RFC 9460,|IETF      |
   |           |                 | keys in this   |Section 8|          |
   |           |                 | RR             |         |          |
   +-----------+-----------------+----------------+---------+----------+
   |     1     | alpn            | Additional     |RFC 9460,|IETF      |
   |           |                 | supported      |Section  |          |
   |           |                 | protocols      |7.1      |          |
   +-----------+-----------------+----------------+---------+----------+
   |     2     | no-default-alpn | No support     |RFC 9460,|IETF      |
   |           |                 | for default    |Section  |          |
   |           |                 | protocol       |7.1      |          |
   +-----------+-----------------+----------------+---------+----------+
   |     3     | port            | Port for       |RFC 9460,|IETF      |
   |           |                 | alternative    |Section  |          |
   |           |                 | endpoint       |7.2      |          |
   +-----------+-----------------+----------------+---------+----------+
   |     4     | ipv4hint        | IPv4 address   |RFC 9460,|IETF      |
   |           |                 | hints          |Section  |          |
   |           |                 |                |7.3      |          |
   +-----------+-----------------+----------------+---------+----------+
   |     5     | ech             | RESERVED       |N/A      |IETF      |
   |           |                 | (held for      |         |          |
   |           |                 | Encrypted      |         |          |
   |           |                 | ClientHello)   |         |          |
   +-----------+-----------------+----------------+---------+----------+
   |     6     | ipv6hint        | IPv6 address   |RFC 9460,|IETF      |
   |           |                 | hints          |Section  |          |
   |           |                 |                |7.3      |          |
   +-----------+-----------------+----------------+---------+----------+
   |65280-65534| N/A             | Reserved for   |RFC 9460 |IETF      |
   |           |                 | Private Use    |         |          |
   +-----------+-----------------+----------------+---------+----------+
   |   65535   | N/A             | Reserved       |RFC 9460 |IETF      |
   |           |                 | ("Invalid      |         |          |
   |           |                 | key")          |         |          |
   +-----------+-----------------+----------------+---------+----------+

parsing done via:
  *  a 2 octet field containing the SvcParamKey as an integer in
     network byte order.  (See Section 14.3.2 for the defined values.)

Variants

Mandatory

Mandatory keys in this RR

Alpn

Additional supported protocols

NoDefaultAlpn

No support for default protocol

Port

Port for alternative endpoint

Ipv4Hint

IPv4 address hints

EchConfigList

Encrypted Client Hello configuration list

Ipv6Hint

IPv6 address hints

Key(u16)

Private Use

Key65535

Reserved (“Invalid key”)

Unknown(u16)

Unknown

Trait Implementations

impl<'r> BinDecodable<'r> for SvcParamKey

fn read(decoder: &mut BinDecoder<'r>) -> Result<Self, ProtoError>

Read the type from the stream

fn from_bytes(bytes: &'r [u8]) -> Result<Self, ProtoError>

Returns the object in binary form

impl BinEncodable for SvcParamKey

fn emit(&self, encoder: &mut BinEncoder<'_>) -> Result<(), ProtoError>

Write the type to the stream

fn to_bytes(&self) -> Result<Vec<u8>, ProtoError>

Returns the object in binary form

impl Clone for SvcParamKey

fn clone(&self) -> SvcParamKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SvcParamKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SvcParamKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<SvcParamKey> for u16

fn from(val: SvcParamKey) -> Self

Converts to this type from the input type.

impl From<u16> for SvcParamKey

fn from(val: u16) -> Self

Converts to this type from the input type.

impl FromStr for SvcParamKey

type Err = ProtoError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SvcParamKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SvcParamKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SvcParamKey

fn eq(&self, other: &SvcParamKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SvcParamKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SvcParamKey

impl Eq for SvcParamKey

impl StructuralPartialEq for SvcParamKey