Struct dns_protocol::Message

pub struct Message<'arrays, 'innards> { /* private fields */ }

The message for a DNS query.

Implementations

impl<'arrays, 'innards> Message<'arrays, 'innards>

pub fn new(
    id: u16,
    flags: Flags,
    questions: &'arrays mut [Question<'innards>],
    answers: &'arrays mut [ResourceRecord<'innards>],
    authorities: &'arrays mut [ResourceRecord<'innards>],
    additional: &'arrays mut [ResourceRecord<'innards>]
) -> Self

Create a new message from a set of buffers for each section.

Panics

This function panics if the number of questions, answers, authorities, or additional records is greater than u16::MAX.

pub fn id(&self) -> u16

Get the ID of this message.

pub fn id_mut(&mut self) -> &mut u16

Get a mutable reference to the ID of this message.

pub fn header(&self) -> Header

Get the header of this message.

pub fn flags(&self) -> Flags

Get the flags for this message.

pub fn flags_mut(&mut self) -> &mut Flags

Get a mutable reference to the flags for this message.

pub fn questions(&self) -> &[Question<'innards>]

Get the questions in this message.

pub fn questions_mut(&mut self) -> &mut [Question<'innards>]

Get a mutable reference to the questions in this message.

pub fn answers(&self) -> &[ResourceRecord<'innards>]

Get the answers in this message.

pub fn answers_mut(&mut self) -> &mut [ResourceRecord<'innards>]

Get a mutable reference to the answers in this message.

pub fn authorities(&self) -> &[ResourceRecord<'innards>]

Get the authorities in this message.

pub fn authorities_mut(&mut self) -> &mut [ResourceRecord<'innards>]

Get a mutable reference to the authorities in this message.

pub fn additional(&self) -> &[ResourceRecord<'innards>]

Get the additional records in this message.

pub fn additional_mut(&mut self) -> &mut [ResourceRecord<'innards>]

Get a mutable reference to the additional records in this message.

pub fn space_needed(&self) -> usize

Get the buffer space needed to serialize this message.

pub fn write(&self, buffer: &mut [u8]) -> Result<usize, Error>

Write this message to a buffer.

Returns the number of bytes written.

Errors

This function may raise Error::NameTooLong if a Label is too long to be serialized.

Panics

This function panics if the buffer is not large enough to hold the serialized message. This panic can be avoided by ensuring the buffer contains at least [space_needed] bytes.

pub fn read(
    buffer: &'innards [u8],
    questions: &'arrays mut [Question<'innards>],
    answers: &'arrays mut [ResourceRecord<'innards>],
    authorities: &'arrays mut [ResourceRecord<'innards>],
    additional: &'arrays mut [ResourceRecord<'innards>]
) -> Result<Message<'arrays, 'innards>, Error>

Read a message from a buffer.

Errors

This function may raise one of the following errors:

• Error::NotEnoughReadBytes if the buffer is not large enough to hold the entire structure. You may need to read more data before calling this function again.
• Error::NotEnoughWriteSpace if the buffers provided are not large enough to hold the entire structure. You may need to allocate larger buffers before calling this function.
• Error::InvalidUtf8 if a domain name contains invalid UTF-8.
• Error::NameTooLong if a domain name is too long to be deserialized.
• Error::InvalidCode if a domain name contains an invalid label code.

Trait Implementations

impl Debug for Message<'_, '_>

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

Formats the value using the given formatter.

impl<'arrays, 'innards> Default for Message<'arrays, 'innards>

fn default() -> Message<'arrays, 'innards>

Returns the “default value” for a type.

impl<'arrays, 'innards> Hash for Message<'arrays, 'innards>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<'arrays, 'innards> Ord for Message<'arrays, 'innards>

fn cmp(&self, other: &Message<'arrays, 'innards>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'arrays, 'innards> PartialEq<Message<'arrays, 'innards>> for Message<'arrays, 'innards>

fn eq(&self, other: &Message<'arrays, 'innards>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'arrays, 'innards> PartialOrd<Message<'arrays, 'innards>> for Message<'arrays, 'innards>

fn partial_cmp(&self, other: &Message<'arrays, 'innards>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'arrays, 'innards> Eq for Message<'arrays, 'innards>

impl<'arrays, 'innards> StructuralEq for Message<'arrays, 'innards>

impl<'arrays, 'innards> StructuralPartialEq for Message<'arrays, 'innards>