Struct domain::base::opt::Opt

pub struct Opt<Octets> { /* fields omitted */ }

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<Octets: AsRef<[u8]>> Opt<Octets>

pub fn from_octets(octets: Octets) -> 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 iter<Data>(&self) -> OptIter<&Octets, Data> where
    &'a Octets: OctetsRef,
    Data: for<'a> ParseOptData<&'a Octets>, 

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.

Trait Implementations

impl<Octets> AsRef<Opt<Octets>> for OptRecord<Octets>

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

Performs the conversion.

impl<Octets: Clone> Clone for Opt<Octets>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octets: AsRef<[u8]>> Compose for Opt<Octets>

fn compose<T: OctetsBuilder>(&self, target: &mut T) -> Result<(), ShortBuf>

Appends the concrete representation of the value to the target.

fn compose_canonical<T: OctetsBuilder>(
    &self,
    target: &mut T
) -> Result<(), ShortBuf>

Appends the canonical representation of the value to the target.

impl<Octets: AsRef<[u8]>> Debug for Opt<Octets>

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

Formats the value using the given formatter.

impl<Octets: AsRef<[u8]>> Display for Opt<Octets>

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

Formats the value using the given formatter.

impl<Octets: AsRef<[u8]>> Eq for Opt<Octets>

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

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

Performs the conversion.

impl<Octets: AsRef<[u8]>> Hash for Opt<Octets>

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, 

Feeds a slice of this type into the given [Hasher].

impl<Octets: AsRef<[u8]>> Ord for Opt<Octets>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Ref: OctetsRef> Parse<Ref> for Opt<Ref::Range>

fn parse(parser: &mut Parser<Ref>) -> Result<Self, ParseError>

Extracts a value from the beginning of parser.

fn skip(parser: &mut Parser<Ref>) -> Result<(), ParseError>

Skips over a value of this type at the beginning of parser.

impl<Octets, Other> PartialEq<Opt<Other>> for Opt<Octets> where
    Octets: AsRef<[u8]>,
    Other: AsRef<[u8]>, 

fn eq(&self, other: &Opt<Other>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Octets, Other> PartialOrd<Opt<Other>> for Opt<Octets> where
    Octets: AsRef<[u8]>,
    Other: AsRef<[u8]>, 

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

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Octets> RtypeRecordData for Opt<Octets>

const RTYPE: Rtype

The record type of a value of this type.