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

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)

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.

§

NoDefaultAlpn

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

§

Port(u16)

   6.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>)

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

§

EchConfig(EchConfig)

6.3.  "echconfig"

  The SvcParamKey to enable Encrypted ClientHello (ECH) is "echconfig".
  Its value is defined in Section 9.  It is applicable to most TLS-
  based protocols.

  When publishing a record containing an "echconfig" parameter, the
  publisher MUST ensure that all IP addresses of TargetName correspond
  to servers that have access to the corresponding private key or are
  authoritative for the public name.  (See Section 7.2.2 of [ECH] for
  more details about the public name.)  This yields an anonymity set of
  cardinality equal to the number of ECH-enabled server domains
  supported by a given client-facing server.  Thus, even with an
  encrypted ClientHello, an attacker who can enumerate the set of ECH-
  enabled domains supported by a client-facing server can guess the
  correct SNI with probability at least 1/K, where K is the size of
  this ECH-enabled server anonymity set.  This probability may be
  increased via traffic analysis or other mechanisms.
§

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§

source§

impl SvcParamValue

source

pub fn is_mandatory(&self) -> bool

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

source

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

source

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

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

source

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

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

source

pub fn is_alpn(&self) -> bool

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

source

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

source

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

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

source

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

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

source

pub fn is_no_default_alpn(&self) -> bool

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

source

pub fn is_port(&self) -> bool

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

source

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

source

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

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

source

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

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

source

pub fn is_ipv4_hint(&self) -> bool

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

source

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

source

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

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

source

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

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

source

pub fn is_ech_config(&self) -> bool

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

source

pub fn as_ech_config_mut(&mut self) -> Option<&mut EchConfig>

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

source

pub fn as_ech_config(&self) -> Option<&EchConfig>

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

source

pub fn into_ech_config(self) -> Result<EchConfig, Self>

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

source

pub fn is_ipv6_hint(&self) -> bool

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

source

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

source

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

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

source

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

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

source

pub fn is_unknown(&self) -> bool

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

source

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

source

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

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

source

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

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

Trait Implementations§

source§

impl BinEncodable for SvcParamValue

source§

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

Write the type to the stream
source§

fn to_bytes(&self) -> ProtoResult<Vec<u8>>

Returns the object in binary form
source§

impl Clone for SvcParamValue

source§

fn clone(&self) -> SvcParamValue

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SvcParamValue

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for SvcParamValue

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for SvcParamValue

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for SvcParamValue

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for SvcParamValue

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for SvcParamValue

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for SvcParamValue

source§

impl StructuralEq for SvcParamValue

source§

impl StructuralPartialEq for SvcParamValue

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,