Struct OptBuilder

pub struct OptBuilder { /* private fields */ }

Builds an OPT record as part of the additional section of a DNS message,

This type can be constructed by calling the opt method on any other builder type. See the module documentation for on overview on building messages.

As OPT records are part of the additional section, this type will, when constructed proceed to this section and append an OPT record without any options to it. Options can be appened via the push method.

The type also deref-muts to OptHeader allowing you to modify the header’s fields such as setting the UDP payload size or the DO bit.

Once you have adjusted the OPT record to your liking, you can return to the additional section via additional. Note, however, that the OPT record should be the last record except for a possible TSIG record. You can also finish the message via finish or freeze.

Implementations

impl OptBuilder

pub fn push<O: OptData>(&mut self, option: &O) -> Result<(), ShortBuf>

Pushes an option to the OPT record.

The method is generic over anything that implements the OptData trait representing an option. Alternatively, most of these types provide a push associated function that allows to construct an option directly into a record from its data.

pub fn additional(self) -> AdditionalBuilder

Completes the OPT record and returns to the additional section builder.

Methods from Deref<Target = OptHeader>

pub fn udp_payload_size(&self) -> u16

pub fn set_udp_payload_size(&mut self, value: u16)

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

pub fn set_rcode(&mut self, rcode: OptRcode)

pub fn version(&self) -> u8

pub fn set_version(&mut self, version: u8)

pub fn dnssec_ok(&self) -> bool

pub fn set_dnssec_ok(&mut self, value: bool)

Trait Implementations

impl Clone for OptBuilder

fn clone(&self) -> OptBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptBuilder

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

Formats the value using the given formatter.

impl Deref for OptBuilder

type Target = OptHeader

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for OptBuilder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl SectionBuilder for OptBuilder

fn into_target(self) -> MessageTarget

Converts into target

fn get_target(&self) -> &MessageTarget

Returns message target

fn get_target_mut(&mut self) -> &mut MessageTarget

Returns message target

fn set_limit(&mut self, limit: usize)

Updates the message’s size limit.

fn header(&self) -> &Header

Returns a reference to the messages header.

fn header_mut(&mut self) -> &mut Header

Returns a mutable reference to the messages header.

fn preview(&self) -> &[u8]

Returns a reference to the message assembled so far.

fn prelude(&self) -> &[u8]

Returns a reference to the slice preceeding the message.

fn prelude_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the slice preceeding the message.

fn finish(self) -> BytesMut

Finishes the message and returns the underlying bytes buffer.

fn freeze(self) -> Message

Finishes the message and returns the resulting bytes value.

fn snapshot(&self) -> Snapshot<Self>

Returns a snapshot indicating the current state of the message.

fn rewind(&mut self, snapshot: &Snapshot<Self>)

Rewinds the message to the state it had at snapshot.