Struct QuestionBuilder

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

Builds the question section of a DNS message.

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

You can push questions to the end of the question section via the push method. It accepts various things that represent a question: question values and references; tuples of a domain name, record type, and class; and, using the regular class of IN, a pair of just a domain name and record type.

Once you are finished building the question section, you can progress to the answer section via the answer method or finish the message via finish. Additionally, conversions to all other builder types are available as well.

Implementations

impl<Target: Composer> QuestionBuilder<Target>

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

Appends a question to the question section.

This method accepts anything that implements the ComposeQuestion trait. Apart from an actual Question or a reference to it, this can also be a tuple of a domain name, record type, and class or, if the class is the usual IN, a pair of just the name and type.

In other words, the options are:

use domain::base::{Name, MessageBuilder, Question, Rtype};
use domain::base::iana::Class;

let mut msg = MessageBuilder::new_vec().question();
msg.push(Question::new_in(Name::root_ref(), Rtype::A)).unwrap();
msg.push(&Question::new_in(Name::root_ref(), Rtype::A)).unwrap();
msg.push((Name::root_ref(), Rtype::A, Class::IN)).unwrap();
msg.push((Name::root_ref(), Rtype::A)).unwrap();

impl<Target: Composer> QuestionBuilder<Target>

Conversions

Additional conversion are available via the Deref implementation.

pub fn rewind(&mut self)

Rewinds to an empty question section.

All previously added questions will be lost.

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

Converts the question builder into a message builder.

All questions will be dropped and the question section will be empty.

impl<Target> QuestionBuilder<Target>

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

Converts the question builder into a question builder.

In other words, doesn’t do anything.

impl<Target: Composer> QuestionBuilder<Target>

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

Converts the question builder into an answer builder.

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

Converts the question builder into an authority builder.

This will leave the answer section empty.

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

Converts the question builder into an additional builder.

This will leave the answer and authority sections empty.

pub fn finish(self) -> Target

Converts the question builder into the underlying octets builder.

This will leave the answer, authority, and additional sections empty.

impl<Target: FreezeBuilder> QuestionBuilder<Target>

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

Converts the question builder into the final message.

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

impl<Target> QuestionBuilder<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 QuestionBuilder<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 QuestionBuilder<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 QuestionBuilder<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 QuestionBuilder<Target>

fn as_ref(&self) -> &Target

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

impl<Target: Clone> Clone for QuestionBuilder<Target>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Target: Debug> Debug for QuestionBuilder<Target>

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

Formats the value using the given formatter.

impl<Target> Deref for QuestionBuilder<Target>

type Target = MessageBuilder<Target>

The resulting type after dereferencing.

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

Dereferences the value.

impl<Target> DerefMut for QuestionBuilder<Target>

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

Mutably dereferences the value.

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 QuestionBuilder<Target>

where Target: Composer,

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

Converts to this type from the input type.

impl<Target> From<AuthorityBuilder<Target>> for QuestionBuilder<Target>

where Target: Composer,

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

Converts to this type from the input type.

impl<Target> From<MessageBuilder<Target>> for QuestionBuilder<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> From<QuestionBuilder<Target>> for AnswerBuilder<Target>

where Target: Composer,

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

Converts to this type from the input type.

impl<Target> From<QuestionBuilder<Target>> for AuthorityBuilder<Target>

where Target: Composer,

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

Converts to this type from the input type.

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

where Target: FreezeBuilder,

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

Converts to this type from the input type.

impl<Target> From<QuestionBuilder<Target>> for MessageBuilder<Target>

where Target: Composer,

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

Converts to this type from the input type.