Struct domain::base::opt::OptRecord

pub struct OptRecord<Octs> { /* 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.

Implementations

impl<Octs> OptRecord<Octs>

pub fn from_record<N: ToName>(record: Record<N, Opt<Octs>>) -> Self

Converts a regular record into an OPT record

pub fn as_record(&self) -> Record<&'static Name<[u8]>, Opt<&[u8]>>

where Octs: AsRef<[u8]>,

Converts the OPT record into a regular 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 set_udp_payload_size(&mut self, value: u16)

Sets the UDP payload size.

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 set_dnssec_ok(&mut self, value: bool)

pub fn opt(&self) -> &Opt<Octs>

Returns a reference to the raw options.

impl<Octs: Composer> OptRecord<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: Clone> Clone for OptRecord<Octs>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]>> Debug for OptRecord<Octs>

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

Formats the value using the given formatter.

impl<Octs: EmptyBuilder> Default for OptRecord<Octs>

fn default() -> Self

Returns the “default value” for a type.

impl<Octs, N: ToName> From<Record<N, Opt<Octs>>> for OptRecord<Octs>

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

Converts to this type from the input type.

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

where Octs: OctetsFrom<SrcOcts>,

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

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

Performs the conversion.