Struct Mandatory

#[repr(transparent)]
pub struct Mandatory(pub Vec<SvcParamKey>);

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

8.  ServiceMode RR compatibility and mandatory keys

   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.

   A ServiceMode RR is considered "compatible" with a client if the
   client recognizes all the mandatory keys, and their values indicate
   that successful connection establishment is possible. Incompatible RRs
   are ignored (see step 5 of the procedure defined in Section 3)

   The presentation value SHALL be a comma-separated list
   (Appendix A.1) of one or more valid SvcParamKeys, either by their
   registered name or in the unknown-key format (Section 2.1).  Keys MAY
   appear in any order, but MUST NOT appear more than once.  For self-
   consistency (Section 2.4.3), listed keys MUST also appear in the
   SvcParams.

   To enable simpler parsing, this SvcParamValue MUST NOT contain escape
   sequences.

   For example, the following is a valid list of SvcParams:

   ipv6hint=... key65333=ex1 key65444=ex2 mandatory=key65444,ipv6hint

   In wire format, the keys are represented by their numeric values in
   network byte order, concatenated in strictly increasing numeric order.

   This SvcParamKey is always automatically mandatory, and MUST NOT
   appear in its own value-list.  Other automatically mandatory keys
   SHOULD NOT appear in the list either.  (Including them wastes space
   and otherwise has no effect.)

Tuple Fields

0: Vec<SvcParamKey>

Trait Implementations

impl<'r> BinDecodable<'r> for Mandatory

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

This expects the decoder to be limited to only this field, i.e. the end of input for the decoder is the end of input for the fields

   In wire format, the keys are represented by their numeric values in
   network byte order, concatenated in strictly increasing numeric order.

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

Returns the object in binary form

impl BinEncodable for Mandatory

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

This expects the decoder to be limited to only this field, i.e. the end of input for the decoder is the end of input for the fields

   In wire format, the keys are represented by their numeric values in
   network byte order, concatenated in strictly increasing numeric order.

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

Returns the object in binary form

impl Clone for Mandatory

fn clone(&self) -> Mandatory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mandatory

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

Formats the value using the given formatter.

impl Display for Mandatory

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

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

The presentation value SHALL be a comma-separated list (Appendix A.1) of one or more valid SvcParamKeys, either by their registered name or in the unknown-key format (Section 2.1). Keys MAY appear in any order, but MUST NOT appear more than once. For self- consistency (Section 2.4.3), listed keys MUST also appear in the SvcParams.

To enable simpler parsing, this SvcParamValue MUST NOT contain escape sequences.

For example, the following is a valid list of SvcParams:

ipv6hint=… key65333=ex1 key65444=ex2 mandatory=key65444,ipv6hint

impl Hash for Mandatory

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 Mandatory

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

impl StructuralPartialEq for Mandatory