Enum SvcParamValue

pub enum SvcParamValue {
    Mandatory(Mandatory),
    Alpn(Alpn),
    NoDefaultAlpn,
    Port(u16),
    Ipv4Hint(IpHint<A>),
    EchConfigList(EchConfigList),
    Ipv6Hint(IpHint<AAAA>),
    Unknown(Unknown),
}

Warning, it is currently up to users of this type to validate the data against that expected by the key

  *  a 2 octet field containing the length of the SvcParamValue as an
     integer between 0 and 65535 in network byte order (but constrained
     by the RDATA and DNS message sizes).
  *  an octet string of this length whose contents are in a format
     determined by the SvcParamKey.

Variants

Mandatory(Mandatory)

In a ServiceMode RR, a SvcParamKey is considered “mandatory” if the RR will not function correctly for clients that ignore this SvcParamKey. Each SVCB protocol mapping SHOULD specify a set of keys that are “automatically mandatory”, i.e. mandatory if they are present in an RR. The SvcParamKey “mandatory” is used to indicate any mandatory keys for this RR, in addition to any automatically mandatory keys that are present.

see Mandatory

Alpn(Alpn)

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

   The "alpn" and "no-default-alpn" SvcParamKeys together indicate the
   set of Application Layer Protocol Negotiation (ALPN) protocol
   identifiers [Alpn] and associated transport protocols supported by
   this service endpoint (the "SVCB ALPN set").

NoDefaultAlpn

For “no-default-alpn”, the presentation and wire format values MUST be empty. See also Alpn

Port(u16)

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

   7.2.  "port"

  The "port" SvcParamKey defines the TCP or UDP port that should be
  used to reach this alternative endpoint.  If this key is not present,
  clients SHALL use the authority endpoint's port number.

  The presentation value of the SvcParamValue is a single decimal
  integer between 0 and 65535 in ASCII.  Any other value (e.g. an
  empty value) is a syntax error.  To enable simpler parsing, this
  SvcParam MUST NOT contain escape sequences.

  The wire format of the SvcParamValue is the corresponding 2 octet
  numeric value in network byte order.

  If a port-restricting firewall is in place between some client and
  the service endpoint, changing the port number might cause that
  client to lose access to the service, so operators should exercise
  caution when using this SvcParamKey to specify a non-default port.

Ipv4Hint(IpHint<A>)

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

The “ipv4hint” and “ipv6hint” keys convey IP addresses that clients MAY use to reach the service. If A and AAAA records for TargetName are locally available, the client SHOULD ignore these hints. Otherwise, clients SHOULD perform A and/or AAAA queries for TargetName as in Section 3, and clients SHOULD use the IP address in those responses for future connections. Clients MAY opt to terminate any connections using the addresses in hints and instead switch to the addresses in response to the TargetName query. Failure to use A and/or AAAA response addresses could negatively impact load balancing or other geo-aware features and thereby degrade client performance.

see IpHint

EchConfigList(EchConfigList)

draft-ietf-tls-svcb-ech-01 Bootstrapping TLS Encrypted ClientHello with DNS Service Bindings, Sep 2024

2.  "SvcParam for ECH configuration"

  The "ech" SvcParamKey is defined for conveying the ECH configuration
  of an alternative endpoint. It is applicable to all TLS-based protocols
  (including DTLS [RFC9147] and QUIC version 1 [RFC9001]) unless otherwise
  specified.

Ipv6Hint(IpHint<AAAA>)

See IpHint

Unknown(Unknown)

Unparsed network data. Refer to documents on the associated key value

This will be left as is when read off the wire, and encoded in bas64 for presentation.

Implementations

impl SvcParamValue

pub fn is_mandatory(&self) -> bool

Returns true if this is a SvcParamValue::Mandatory, otherwise false

pub fn as_mandatory_mut(&mut self) -> Option<&mut Mandatory>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Mandatory, otherwise None

pub fn as_mandatory(&self) -> Option<&Mandatory>

Optionally returns references to the inner fields if this is a SvcParamValue::Mandatory, otherwise None

pub fn into_mandatory(self) -> Result<Mandatory, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Mandatory, otherwise returns back the enum in the Err case of the result

pub fn is_alpn(&self) -> bool

Returns true if this is a SvcParamValue::Alpn, otherwise false

pub fn as_alpn_mut(&mut self) -> Option<&mut Alpn>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Alpn, otherwise None

pub fn as_alpn(&self) -> Option<&Alpn>

Optionally returns references to the inner fields if this is a SvcParamValue::Alpn, otherwise None

pub fn into_alpn(self) -> Result<Alpn, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Alpn, otherwise returns back the enum in the Err case of the result

pub fn is_no_default_alpn(&self) -> bool

Returns true if this is a SvcParamValue::NoDefaultAlpn, otherwise false

pub fn is_port(&self) -> bool

Returns true if this is a SvcParamValue::Port, otherwise false

pub fn as_port_mut(&mut self) -> Option<&mut u16>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Port, otherwise None

pub fn as_port(&self) -> Option<&u16>

Optionally returns references to the inner fields if this is a SvcParamValue::Port, otherwise None

pub fn into_port(self) -> Result<u16, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Port, otherwise returns back the enum in the Err case of the result

pub fn is_ipv4_hint(&self) -> bool

Returns true if this is a SvcParamValue::Ipv4Hint, otherwise false

pub fn as_ipv4_hint_mut(&mut self) -> Option<&mut IpHint<A>>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Ipv4Hint, otherwise None

pub fn as_ipv4_hint(&self) -> Option<&IpHint<A>>

Optionally returns references to the inner fields if this is a SvcParamValue::Ipv4Hint, otherwise None

pub fn into_ipv4_hint(self) -> Result<IpHint<A>, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Ipv4Hint, otherwise returns back the enum in the Err case of the result

pub fn is_ech_config_list(&self) -> bool

Returns true if this is a SvcParamValue::EchConfigList, otherwise false

pub fn as_ech_config_list_mut(&mut self) -> Option<&mut EchConfigList>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::EchConfigList, otherwise None

pub fn as_ech_config_list(&self) -> Option<&EchConfigList>

Optionally returns references to the inner fields if this is a SvcParamValue::EchConfigList, otherwise None

pub fn into_ech_config_list(self) -> Result<EchConfigList, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::EchConfigList, otherwise returns back the enum in the Err case of the result

pub fn is_ipv6_hint(&self) -> bool

Returns true if this is a SvcParamValue::Ipv6Hint, otherwise false

pub fn as_ipv6_hint_mut(&mut self) -> Option<&mut IpHint<AAAA>>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Ipv6Hint, otherwise None

pub fn as_ipv6_hint(&self) -> Option<&IpHint<AAAA>>

Optionally returns references to the inner fields if this is a SvcParamValue::Ipv6Hint, otherwise None

pub fn into_ipv6_hint(self) -> Result<IpHint<AAAA>, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Ipv6Hint, otherwise returns back the enum in the Err case of the result

pub fn is_unknown(&self) -> bool

Returns true if this is a SvcParamValue::Unknown, otherwise false

pub fn as_unknown_mut(&mut self) -> Option<&mut Unknown>

Optionally returns mutable references to the inner fields if this is a SvcParamValue::Unknown, otherwise None

pub fn as_unknown(&self) -> Option<&Unknown>

Optionally returns references to the inner fields if this is a SvcParamValue::Unknown, otherwise None

pub fn into_unknown(self) -> Result<Unknown, SvcParamValue>

Returns the inner fields if this is a SvcParamValue::Unknown, otherwise returns back the enum in the Err case of the result

Trait Implementations

impl BinEncodable for SvcParamValue

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 SvcParamValue

fn clone(&self) -> SvcParamValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SvcParamValue

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

Formats the value using the given formatter.

impl Display for SvcParamValue

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

Formats the value using the given formatter.

impl Hash for SvcParamValue

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

where __H: Hasher,

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 PartialEq for SvcParamValue

fn eq(&self, other: &SvcParamValue) -> 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 Eq for SvcParamValue

impl StructuralPartialEq for SvcParamValue