Struct domain::rdata::svcb::SvcbRdata

pub struct SvcbRdata<Variant, Octs, Name> { /* private fields */ }

Service binding record data.

This type provides the record data for the various service binding record types. The particular record type is encoded via the Variant type argument with marker types representing the concrete types. Currently these are ScvbVariant for the SVCB record type and HttpsVariant for HTTPS. The aliases Svcb<..> and Https<..> are available for less typing.

The service binding record data contains three fields: a integer priority, a target name – the type of which is determined by the Name type argument –, and a sequence of service parameters. A separate type SvcParams has been defined for those which is generic over an octets sequence determined by the Octs type argument.

The record can be used in one of two modes, ‘alias mode’ or ‘service mode.’

In alias mode, there should only be one record with its priority set to 0 and no service parameters. In this case, the target name indicates the name that actually provides the service and should be resolved further. The root name can be used as the target name to indicate that the particular service is not being provided.

In ‘service mode,’ one or more records can exist and used in the order provided by the priority field with lower priority looked at first. Each record describes an alternative endpoint for the service and parameters for its use. What exactly this means depends on the protocol in question.

The owner name of service binding records determines which service the records apply to. The domain name for which the service is provided is prefixed by first the port and protocol of the service, both as underscore labels. So, for HTTPS on port 443, the prefix would be _443._https. However, the HTTPS record type allows to drop the prefix in that particular case.

Note that the above is a wholy inadequate summary of service bindings records. For accurate details, see draft-ietf-dnsop-svcb-https.

Implementations

impl<Variant, Octs, Name> SvcbRdata<Variant, Octs, Name>

pub fn new( priority: u16, target: Name, params: SvcParams<Octs>, ) -> Result<Self, LongRecordData>

where Octs: AsRef<[u8]>, Name: ToDname,

Create a new value from its components.

Returns an error if the wire format of the record data would exceed the length of 65,535 octets.

pub unsafe fn new_unchecked( priority: u16, target: Name, params: SvcParams<Octs>, ) -> Self

Creates a new value from its components without checking.

Safety

The called must ensure that the wire format of the record data does not exceed a length of 65,535 octets.

impl<Variant, Octs: AsRef<[u8]>> SvcbRdata<Variant, Octs, ParsedDname<Octs>>

pub fn parse<'a, Src: Octets<Range<'a> = Octs> + ?Sized + 'a>( parser: &mut Parser<'a, Src>, ) -> Result<Self, ParseError>

Parses service bindings record data from its wire format.

impl<Variant, Octs, Name> SvcbRdata<Variant, Octs, Name>

pub fn priority(&self) -> u16

Returns the priority.

pub fn is_alias(&self) -> bool

Returns whether this service binding is in alias mode.

This is identical to self.priority() == 0.

pub fn is_service(&self) -> bool

Returns whether this service binding is in service mode.

This is identical to self.priority() != 0.

pub fn target(&self) -> &Name

Returns the target name.

Note the target name won’t be translated to the owner automatically in service mode if it equals the root name.

pub fn params(&self) -> &SvcParams<Octs>

Returns the parameters.

Trait Implementations

impl<Variant: Clone, Octs: Clone, Name: Clone> Clone for SvcbRdata<Variant, Octs, Name>

fn clone(&self) -> SvcbRdata<Variant, Octs, Name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Variant, Octs, Name> ComposeRecordData for SvcbRdata<Variant, Octs, Name>

where Self: RecordData, Octs: AsRef<[u8]>, Name: ToDname,

fn rdlen(&self, _compress: bool) -> Option<u16>

Returns the length of the record data if available.

fn compose_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the wire format of the record data into target.

fn compose_canonical_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the canonical wire format of the record data into target.

fn compose_len_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the record data prefixed with its length.

fn compose_canonical_len_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the record data prefixed with its length.

impl<Variant, Octs, Name> Debug for SvcbRdata<Variant, Octs, Name>

where Octs: Octets, Name: Debug,

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

Formats the value using the given formatter.

impl<Variant, Octs, Name> Display for SvcbRdata<Variant, Octs, Name>

where Octs: Octets, Name: Display,

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

Formats the value using the given formatter.

impl<Variant, Octs, TOcts, Name, TName> FlattenInto<SvcbRdata<Variant, TOcts, TName>> for SvcbRdata<Variant, Octs, Name>

where TOcts: OctetsFrom<Octs>, Name: FlattenInto<TName, AppendError = TOcts::Error>,

type AppendError = <TOcts as OctetsFrom<Octs>>::Error

fn try_flatten_into( self, ) -> Result<SvcbRdata<Variant, TOcts, TName>, TOcts::Error>

impl<O, N> From<SvcbRdata<HttpsVariant, O, N>> for AllRecordData<O, N>

fn from(value: Https<O, N>) -> Self

Converts to this type from the input type.

impl<O, N> From<SvcbRdata<SvcbVariant, O, N>> for AllRecordData<O, N>

fn from(value: Svcb<O, N>) -> Self

Converts to this type from the input type.

impl<Variant, Octs: AsRef<[u8]>, Name: Hash> Hash for SvcbRdata<Variant, Octs, Name>

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<Variant, Octs, SrcOctets, Name, SrcName> OctetsFrom<SvcbRdata<Variant, SrcOctets, SrcName>> for SvcbRdata<Variant, Octs, Name>

where Octs: OctetsFrom<SrcOctets>, Name: OctetsFrom<SrcName, Error = Octs::Error>,

type Error = <Octs as OctetsFrom<SrcOctets>>::Error

fn try_octets_from( source: SvcbRdata<Variant, SrcOctets, SrcName>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<Variant, Octs: AsRef<[u8]>, Name: ToDname> Ord for SvcbRdata<Variant, Octs, Name>

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 + PartialOrd,

Restrict a value to a certain interval.

impl<'a, Octs: Octets + ?Sized> ParseRecordData<'a, Octs> for SvcbRdata<HttpsVariant, Octs::Range<'a>, ParsedDname<Octs::Range<'a>>>

fn parse_rdata( rtype: Rtype, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the record data.

impl<'a, Octs: Octets + ?Sized> ParseRecordData<'a, Octs> for SvcbRdata<SvcbVariant, Octs::Range<'a>, ParsedDname<Octs::Range<'a>>>

fn parse_rdata( rtype: Rtype, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the record data.

impl<Variant, OtherVariant, Octs, OtherOcts, Name, OtherName> PartialEq<SvcbRdata<OtherVariant, OtherOcts, OtherName>> for SvcbRdata<Variant, Octs, Name>

where Octs: AsRef<[u8]>, OtherOcts: AsRef<[u8]>, Name: ToDname, OtherName: ToDname,

fn eq(&self, other: &SvcbRdata<OtherVariant, OtherOcts, OtherName>) -> 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<Variant, OtherVariant, Octs, OtherOcts, Name, OtherName> PartialOrd<SvcbRdata<OtherVariant, OtherOcts, OtherName>> for SvcbRdata<Variant, Octs, Name>

where Octs: AsRef<[u8]>, OtherOcts: AsRef<[u8]>, Name: ToDname, OtherName: ToDname,

fn partial_cmp( &self, other: &SvcbRdata<OtherVariant, OtherOcts, OtherName>, ) -> 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<Octs, Name> RecordData for SvcbRdata<HttpsVariant, Octs, Name>

fn rtype(&self) -> Rtype

Returns the record type associated with this record data instance.

impl<Octs, Name> RecordData for SvcbRdata<SvcbVariant, Octs, Name>

fn rtype(&self) -> Rtype

Returns the record type associated with this record data instance.

impl<Variant, Octs: AsRef<[u8]>, Name: ToDname> Eq for SvcbRdata<Variant, Octs, Name>