Struct domain::base::opt::OptRecord

pub struct OptRecord<Octets> { /* private fields */ }

An entire OPT record.

Because the EDNS specificiation uses parts of the header of the OPT record to convey some information, a special record type is necessary for OPT records. You can convert a normal record with Opt record data into an OptRecord via the from_record function.

The type derefs to the Opt type and provides all its functionality that way.

Implementations

impl<Octets> OptRecord<Octets>

pub fn from_record<N: ToDname>(record: Record<N, Opt<Octets>>) -> Self

Converts a regular record into an OPT record

pub fn udp_payload_size(&self) -> u16

Returns the UDP payload size.

Through this field a sender of a message can signal the maximum size of UDP payload the sender is able to handle when receiving messages. This value refers to the abilities of the sender’s DNS implementation, not such things as network MTUs. Which means that the largest UDP payload that can actually be sent back to the sender may be smaller.

pub fn rcode(&self, header: Header) -> OptRcode

Returns the extended rcode.

Some of the bits of the rcode are stored in the regular message header. Such a header needs to be passed to the method.

pub fn version(&self) -> u8

Returns the EDNS version of the OPT header.

Only EDNS version 0 is currently defined.

pub fn dnssec_ok(&self) -> bool

Returns the value of the DNSSEC OK (DO) bit.

By setting this bit, a resolver indicates that it is interested in also receiving the DNSSEC-related resource records necessary to validate an answer. The bit and the related procedures are defined in RFC 3225.

pub fn as_opt(&self) -> &Opt<Octets>

Returns a reference to the raw options.

Methods from Deref<Target = Opt<Octets>>

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

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

impl<Octets: Clone> Clone for OptRecord<Octets>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octets> Deref for OptRecord<Octets>

type Target = Opt<Octets>

The resulting type after dereferencing.

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

Dereferences the value.

impl<Octets, N: ToDname> From<Record<N, Opt<Octets>>> for OptRecord<Octets>

fn from(record: Record<N, Opt<Octets>>) -> Self

Converts to this type from the input type.

impl<Octets, SrcOctets> OctetsFrom<OptRecord<SrcOctets>> for OptRecord<Octets>where
    Octets: OctetsFrom<SrcOctets>,

fn octets_from(source: OptRecord<SrcOctets>) -> Result<Self, ShortBuf>

Performs the conversion.