Struct domain::base::message_builder::AdditionalBuilder

pub struct AdditionalBuilder<Target> { /* private fields */ }

Builds the additional section of a DNS message.

A value of this type can be acquired by calling the additional method on any other builder type. See the module documentation for an overview of how to build a message.

You can push records to the end of the additional section via the push method. It accepts various things that represent resource records: record values and references, tuples of an owner domain name, a class, TTL, and record data, as well as tuples of just the owner, TTL, and data, assuming the class of IN.

A special method exists to make adding an OPT record to the section easier. The opt method creates an OptBuilder and passes it to a closure. This way, you can add and remove OPT records from additional builders that are part of another type and cannot be traded in easily.

Once you are finished building the additional section, you can finish the message via finish. Additionally, conversions to all other builder types are available as well.

Implementations

impl<Target: Composer> AdditionalBuilder<Target>

pub fn push(&mut self, record: impl ComposeRecord) -> Result<(), PushError>

Appends a record to the additional section.

This methods accepts anything that implements the ComposeRecord trait. Apart from record values and references, this are tuples of the owner domain name, optionally the class (which is taken to be IN if missing), the TTL, and record data.

In other words, you can do the following things:

use domain::base::{Name, MessageBuilder, Record, Rtype, Ttl};
use domain::base::iana::Class;
use domain::rdata::A;

let mut msg = MessageBuilder::new_vec().additional();
let record = Record::new(
    Name::root_ref(), Class::IN, Ttl::from_secs(86400), A::from_octets(192, 0, 2, 1)
);
msg.push(&record).unwrap();
msg.push(record).unwrap();
msg.push(
    (Name::root_ref(), Class::IN, 86400, A::from_octets(192, 0, 2, 1))
).unwrap();
msg.push(
    (Name::root_ref(), 86400, A::from_octets(192, 0, 2, 1))
).unwrap();

impl<Target: Composer> AdditionalBuilder<Target>

pub fn opt<F>(&mut self, op: F) -> Result<(), PushError>

where F: FnOnce(&mut OptBuilder<'_, Target>) -> Result<(), Target::AppendError>,

Appends and builds an OPT record.

The actual building of the record is handled by a closure that receives an OptBuilder which can both change the header of the record and add options.

The method will return whatever the closure returns. In addition, it will return an error if it failed to add the header of the OPT record.

impl<Target: Composer> AdditionalBuilder<Target>

Conversions

Additional conversion methods are available via the Deref implementation.

pub fn rewind(&mut self)

Rewinds to an empty additional section.

All previously added additional records will be lost.

pub fn builder(self) -> MessageBuilder<Target>

Converts the additional builder into a message builder.

All questions and records will be dropped and all sections will be empty.

pub fn question(self) -> QuestionBuilder<Target>

Converts the additional builder into a question builder.

All answer, authority, and additional records will be dropped. All previously added questions will, however, remain.

pub fn answer(self) -> AnswerBuilder<Target>

Converts the additional builder into an answer builder.

All authority and additional records will be dropped. All questions and answer records will remain.

pub fn authority(self) -> AuthorityBuilder<Target>

Converts the additional builder into an authority builder.

All additional records will be dropped. All questions, answer, and authority records will remain.

pub fn additional(self) -> AdditionalBuilder<Target>

Converts the additional builder into an additional builder.

In other words, does absolutely nothing.

pub fn finish(self) -> Target

Converts the additional builder into the underlying octets builder.

impl<Target: FreezeBuilder> AdditionalBuilder<Target>

pub fn into_message(self) -> Message<Target::Octets>

Converts the additional builder into the final message.

The method will return a message atop whatever octets sequence the builder’s octets builder converts into.

impl<Target> AdditionalBuilder<Target>

pub fn as_builder(&self) -> &MessageBuilder<Target>

Returns a reference to the underlying message builder.

pub fn as_builder_mut(&mut self) -> &mut MessageBuilder<Target>

Returns a mutable reference to the underlying message builder.

Methods from Deref<Target = MessageBuilder<Target>>

pub fn set_push_limit(&mut self, limit: usize)

Limit how much of the underlying buffer may be used.

When a limit is set, calling push() on a message section (e.g. AdditionalBuilder::push()) will fail if the limit is exceeded just as if the actual end of the underlying buffer had been reached.

Note: Calling this function does NOT truncate the underlying buffer. If the new limit is lees than the amount of the buffer that has already been used, exisitng content beyond the limit will remain untouched, the length will remain larger than the limit, and calls to push() will fail until the buffer is truncated to a size less than the limit.

pub fn clear_push_limit(&mut self)

Clear the push limit, if set.

Removes any push limit previously set via [set_push_limit()].

pub fn push_limit(&self) -> Option<usize>

Returns the current push limit, if set.

pub fn header(&self) -> Header

Return the current value of the message header.

pub fn counts(&self) -> HeaderCounts

Return the current value of the message header counts.

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

Returns a mutable reference to the message header for manipulations.

pub fn as_target(&self) -> &Target

Returns a reference to the underlying octets builder.

pub fn as_slice(&self) -> &[u8]

where Target: AsRef<[u8]>,

Returns an octets slice of the octets assembled so far.

pub fn as_message(&self) -> Message<&[u8]>

where Target: AsRef<[u8]>,

Returns a message atop for the octets assembled so far.

This message is atop the octets slices derived from the builder, so it can be created cheaply.

Trait Implementations

impl<Target> AsMut<MessageBuilder<Target>> for AdditionalBuilder<Target>

fn as_mut(&mut self) -> &mut MessageBuilder<Target>

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

impl<Target: AsRef<[u8]>> AsRef<[u8]> for AdditionalBuilder<Target>

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

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

impl<Target> AsRef<MessageBuilder<Target>> for AdditionalBuilder<Target>

fn as_ref(&self) -> &MessageBuilder<Target>

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

impl<Target> AsRef<Target> for AdditionalBuilder<Target>

fn as_ref(&self) -> &Target

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

impl<Target: Clone> Clone for AdditionalBuilder<Target>

fn clone(&self) -> AdditionalBuilder<Target>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Target: Debug> Debug for AdditionalBuilder<Target>

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

Formats the value using the given formatter.

impl<Target> Deref for AdditionalBuilder<Target>

type Target = MessageBuilder<Target>

The resulting type after dereferencing.

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

Dereferences the value.

impl<Target> DerefMut for AdditionalBuilder<Target>

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

Mutably dereferences the value.

impl<Target> From<AdditionalBuilder<Target>> for AnswerBuilder<Target>

where Target: Composer,

fn from(src: AdditionalBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AdditionalBuilder<Target>> for AuthorityBuilder<Target>

where Target: Composer,

fn from(src: AdditionalBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AdditionalBuilder<Target>> for Message<Target::Octets>

where Target: FreezeBuilder,

fn from(src: AdditionalBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AdditionalBuilder<Target>> for MessageBuilder<Target>

where Target: Composer,

fn from(src: AdditionalBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AdditionalBuilder<Target>> for QuestionBuilder<Target>

where Target: Composer,

fn from(src: AdditionalBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AnswerBuilder<Target>> for AdditionalBuilder<Target>

where Target: Composer,

fn from(src: AnswerBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<AuthorityBuilder<Target>> for AdditionalBuilder<Target>

where Target: Composer,

fn from(src: AuthorityBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<MessageBuilder<Target>> for AdditionalBuilder<Target>

where Target: Composer,

fn from(src: MessageBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> From<QuestionBuilder<Target>> for AdditionalBuilder<Target>

where Target: Composer,

fn from(src: QuestionBuilder<Target>) -> Self

Converts to this type from the input type.

impl<Target> RecordSectionBuilder<Target> for AdditionalBuilder<Target>

where Target: Composer,

fn push(&mut self, record: impl ComposeRecord) -> Result<(), PushError>

Appends a record to a record section.