Struct domain::base::opt::Opt

pub struct Opt<Octs: ?Sized> { /* private fields */ }

OPT record data.

This is the record data type for OPT records and can be used as the data type parameter in Record. It simply wraps an octets sequence with all the record data. It guarantees that the data contains a correctly formatted sequence of options but doesn’t guarantee that the options themselves are correct. You can iterate over options via the iter method.

Since some of the information of the OPT record is transmitted in the record header, a special type OptRecord exists, that contains all the OPT data which is the preferred way of accessing this data.

Implementations

impl<Octs: Octets> Opt<Octs>

pub fn dau(&self) -> Option<Dau<Octs::Range<'_>>>

Returns the first DAU option if present.

This option lists the DNSSEC signature algorithms the requester supports.

pub fn dhu(&self) -> Option<Dhu<Octs::Range<'_>>>

Returns the first DHU option if present.

This option lists the DS hash algorithms the requester supports.

pub fn n3u(&self) -> Option<N3u<Octs::Range<'_>>>

Returns the first N3U option if present.

This option lists the NSEC3 hash algorithms the requester supports.

impl<Octs: Octets> Opt<Octs>

pub fn chain(&self) -> Option<Chain<Name<Octs::Range<'_>>>>

Returns the first CHAIN option if present.

The CHAIN option allows a client to request that all records that are necessary for DNSSEC validation are included in the response.

impl<Octs: Octets> Opt<Octs>

pub fn cookie(&self) -> Option<Cookie>

Returns the first cookie option if present.

impl<Octs: Octets> Opt<Octs>

pub fn expire(&self) -> Option<Expire>

Returns the content of the Expire option if present.

The Expire option allows an authoritative server to signal its own expiry time of a zone.

impl<Octs: Octets> Opt<Octs>

pub fn extended_error(&self) -> Option<ExtendedError<Octs::Range<'_>>>

Returns the first extended DNS error option if present.

The extended DNS error option carries additional error information in a failed answer.

impl<Octs: Octets> Opt<Octs>

pub fn tcp_keepalive(&self) -> Option<TcpKeepalive>

Returns the first edns-tcp-keepalive option if present.

This option is used to signal a timeout to keep a TCP connection open.

impl<Octs: Octets> Opt<Octs>

pub fn key_tag(&self) -> Option<KeyTag<Octs::Range<'_>>>

Returns the first edns-key-tags option if present.

The option contains a list of the key tags of the trust anchor keys a validating resolver is using for DNSSEC validation.

impl<Octs: Octets> Opt<Octs>

pub fn nsid(&self) -> Option<Nsid<Octs::Range<'_>>>

Returns the first NSID option present.

In a response, the NSID option contains an identifier of the name server that answered the query. In a query, the option is empty and signals a request for inclusion in a response.

impl<Octs: Octets> Opt<Octs>

pub fn client_subnet(&self) -> Option<ClientSubnet>

Returns the first client subnet option if present.

This option allows a resolver to include information about the network a query originated from. This information can then be used by an authoritative server to provide the best response for this network.

impl<Octs: EmptyBuilder> Opt<Octs>

pub fn empty() -> Self

Creates empty OPT record data.

impl<Octs: AsRef<[u8]>> Opt<Octs>

pub fn from_octets(octets: Octs) -> Result<Self, ParseError>

Creates OPT record data from an octets sequence.

The function checks whether the octets contain a sequence of options. It does not check whether the options themselves are valid.

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

Parses OPT record data from the beginning of a parser.

impl Opt<[u8]>

pub fn from_slice(slice: &[u8]) -> Result<&Self, ParseError>

Creates OPT record data from an octets slice.

impl<Octs: AsRef<[u8]> + ?Sized> Opt<Octs>

pub fn for_slice_ref(&self) -> Opt<&[u8]>

impl<Octs: AsRef<[u8]> + ?Sized> Opt<Octs>

pub fn len(&self) -> usize

Returns the length of the OPT record data.

pub fn is_empty(&self) -> bool

Returns whether the OPT record data is empty.

pub fn iter<'s, Data>(&'s self) -> OptIter<'s, Octs, Data>

where Octs: Octets, Data: ParseOptData<'s, Octs>,

Returns an iterator over options of a given type.

The returned iterator will return only options represented by type D and quietly skip over all the others.

pub fn first<'s, Data>(&'s self) -> Option<Data>

where Octs: Octets, Data: ParseOptData<'s, Octs>,

Returns the first option of a given type if present.

If trying to parse this first option fails, returns None as well.

impl<Octs: Composer> Opt<Octs>

pub fn push<Opt: ComposeOptData + ?Sized>( &mut self, option: &Opt, ) -> Result<(), BuildDataError>

Appends a new option to the OPT data.

pub fn push_raw_option<F>( &mut self, code: OptionCode, option_len: u16, op: F, ) -> Result<(), BuildDataError>

where F: FnOnce(&mut Octs) -> Result<(), Octs::AppendError>,

Appends a raw option to the OPT data.

The method will append an option with the given option code. The data of the option will be written via the closure op.

Trait Implementations

impl<Octs> AsRef<Opt<Octs>> for OptRecord<Octs>

fn as_ref(&self) -> &Opt<Octs>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Octs, Other> CanonicalOrd<Opt<Other>> for Opt<Octs>

where Octs: AsRef<[u8]> + ?Sized, Other: AsRef<[u8]> + ?Sized,

fn canonical_cmp(&self, other: &Opt<Other>) -> Ordering

Returns the canonical ordering between self and other.

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

Returns whether self is canonically less than other.

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

Returns whether self is canonically less than or equal to other.

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

Returns whether self is canonically greater than other.

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

Returns whether self is canonically greater than or equal to other.

impl<Octs: Clone + ?Sized> Clone for Opt<Octs>

fn clone(&self) -> Opt<Octs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]> + ?Sized> ComposeRecordData for Opt<Octs>

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<Octs: AsRef<[u8]> + ?Sized> Debug for Opt<Octs>

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

Formats the value using the given formatter.

impl<Octs: AsRef<[u8]> + ?Sized> Display for Opt<Octs>

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

Formats the value using the given formatter.

impl<O, N> From<Opt<O>> for AllRecordData<O, N>

fn from(value: Opt<O>) -> Self

Converts to this type from the input type.

impl<Octs: AsRef<[u8]> + ?Sized> Hash for Opt<Octs>

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

Feeds this value into the given Hasher.

impl<Octs, SrcOcts> OctetsFrom<Opt<SrcOcts>> for Opt<Octs>

where Octs: OctetsFrom<SrcOcts>,

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

fn try_octets_from(source: Opt<SrcOcts>) -> Result<Self, Self::Error>

Performs the conversion.

impl<Octs: AsRef<[u8]> + ?Sized> Ord for Opt<Octs>

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

This method returns an Ordering between self and other.

impl<'a, Octs> ParseRecordData<'a, Octs> for Opt<Octs::Range<'a>>

where Octs: Octets + ?Sized,

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

Parses the record data.

impl<Octs, Other> PartialEq<Opt<Other>> for Opt<Octs>

where Octs: AsRef<[u8]> + ?Sized, Other: AsRef<[u8]> + ?Sized,

fn eq(&self, other: &Opt<Other>) -> 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<Octs, Other> PartialOrd<Opt<Other>> for Opt<Octs>

where Octs: AsRef<[u8]> + ?Sized, Other: AsRef<[u8]> + ?Sized,

fn partial_cmp(&self, other: &Opt<Other>) -> 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: ?Sized> RecordData for Opt<Octs>

fn rtype(&self) -> Rtype

Returns the record type associated with this record data instance.

impl<Octs: AsRef<[u8]> + ?Sized> Eq for Opt<Octs>