Struct domain::base::message_builder::MessageBuilder

pub struct MessageBuilder<Target> { /* fields omitted */ }

Starts building a DNS message.

This type wraps an OctetsBuilder and starts the process of building a message. It allows access to the header section. The message builder can be traded in for any section builder or the underlying octets builder.

For more details see the module documentation.

Implementations

impl<Target: OctetsBuilder> MessageBuilder<Target>

Creating Message Builders

pub fn from_target(target: Target) -> Result<Self, ShortBuf>

Creates a new message builder using the given target.

The target must be an OctetsBuilder. It will be truncated to zero size before appending the header section. That is, all data that was in the builder before will be lost.

The function will result in an error if the builder doesn’t have enough space for the header section.

impl MessageBuilder<Vec<u8>>

pub fn new_vec() -> Self

Creates a new message builder atop a Vec<u8>.

impl MessageBuilder<StreamTarget<Vec<u8>>>

pub fn new_stream_vec() -> Self

Creates a new builder for a streamable message atop a Vec<u8>.

impl<Target: OctetsBuilder> MessageBuilder<Target>

pub fn start_answer<Octets>(
    self,
    msg: &Message<Octets>,
    rcode: Rcode
) -> Result<AnswerBuilder<Target>, ShortBuf> where
    Octets: AsRef<[u8]>,
    &'a Octets: OctetsRef, 

Starts creating an answer for the given message.

Specifically, this sets the ID, QR, OPCODE, RD, and RCODE fields in the header and attempts to push the message’s questions to the builder. If iterating of the questions fails, it adds what it can.

The method converts the message builder into an answer builder ready to receive the answer for the question.

pub fn request_axfr<N: ToDname>(
    self,
    apex: N
) -> Result<AnswerBuilder<Target>, ShortBuf>

Creates an AXFR request for the given domain.

Sets a random ID, pushes the domain and the AXFR record type into the question section, and converts the builder into an answer builder.

impl<Target: OctetsBuilder> MessageBuilder<Target>

Access to the Message Header

pub fn header(&self) -> Header

Return the current value of the message header.

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

Returns a mutable reference to the message header for manipulations.

pub fn counts(&self) -> HeaderCounts

Return the current value of the message header counts.

impl<Target: OctetsBuilder> MessageBuilder<Target>

Conversions

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

Converts the message builder into a message builder

This is a no-op.

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

Converts the message builder into a question builder.

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

Converts the message builder into an answer builder.

This will leave the question section empty.

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

Converts the message builder into an authority builder.

This will leave the question and answer sections empty.

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

Converts the message builder into an additional builder.

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

pub fn finish(self) -> Target

Converts the message into the underlying octets builder.

This will leave the all sections empty.

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

Converts the builder into a message.

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

impl<Target> MessageBuilder<Target>

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>

Performs the conversion.

impl<Target> AsMut<MessageBuilder<Target>> for AnswerBuilder<Target>

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

Performs the conversion.

impl<Target> AsMut<MessageBuilder<Target>> for AuthorityBuilder<Target>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<Target> AsRef<MessageBuilder<Target>> for QuestionBuilder<Target>

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

Performs the conversion.

impl<Target> AsRef<MessageBuilder<Target>> for AnswerBuilder<Target>

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

Performs the conversion.

impl<Target> AsRef<MessageBuilder<Target>> for AuthorityBuilder<Target>

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

Performs the conversion.

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

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

Performs the conversion.

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

fn as_ref(&self) -> &Target

Performs the conversion.

impl<Target: Clone> Clone for MessageBuilder<Target>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Target: Debug> Debug for MessageBuilder<Target>

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

Formats the value using the given formatter.

impl<Target> From<AdditionalBuilder<Target>> for MessageBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<AnswerBuilder<Target>> for MessageBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<AuthorityBuilder<Target>> for MessageBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<MessageBuilder<Target>> for QuestionBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<MessageBuilder<Target>> for AnswerBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<MessageBuilder<Target>> for AuthorityBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<MessageBuilder<Target>> for AdditionalBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.

impl<Target> From<QuestionBuilder<Target>> for MessageBuilder<Target> where
    Target: OctetsBuilder, 

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

Performs the conversion.