Struct domain::base::header::HeaderCounts

pub struct HeaderCounts { /* private fields */ }

The section count part of the header section of a DNS message.

This part consists of four 16 bit counters for the number of entries in the four sections of a DNS message. The type contains the sequence of these for values in wire format, i.e., in network byte order.

The counters are arranged in the same order as the sections themselves: QDCOUNT for the question section, ANCOUNT for the answer section, NSCOUNT for the authority section, and ARCOUNT for the additional section. These are defined in RFC 1035.

Like with the other header part, you can create an owned value via the new method or the Default trait or can get a reference to the value atop a message slice via for_message_slice or for_message_slice_mut.

For each field there are three methods for getting, setting, and incrementing.

RFC 2136 defines the UPDATE method and reuses the four section for different purposes. Here the counters are ZOCOUNT for the zone section, PRCOUNT for the prerequisite section, UPCOUNT for the update section, and ADCOUNT for the additional section. The type has convenience methods for these fields as well so you don’t have to remember which is which.

Implementations

impl HeaderCounts

Creation and Conversion

pub fn new() -> Self

Creates a new value with all counters set to zero.

pub fn for_message_slice(message: &[u8]) -> &Self

Creates a header counts reference from the octets slice of a message.

The slice message mut be the whole message, i.e., start with the bytes of the Header.

Panics

This function panics if the octets slice is shorter than 24 octets.

pub fn for_message_slice_mut(message: &mut [u8]) -> &mut Self

Creates a mutable counts reference from the octets slice of a message.

The slice message mut be the whole message, i.e., start with the bytes of the Header.

Panics

This function panics if the octets slice is shorter than 24 octets.

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

Returns a reference to the raw octets slice of the header counts.

pub fn as_slice_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the octets slice of the header counts.

pub fn set(&mut self, counts: HeaderCounts)

Sets the counts to those from counts.

impl HeaderCounts

Field Access

pub fn qdcount(self) -> u16

Returns the value of the QDCOUNT field.

This field contains the number of questions in the first section of the message, normally the question section.

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

Sets the value of the QDCOUNT field.

pub fn inc_qdcount(&mut self) -> Result<(), CountOverflow>

Increases the value of the QDCOUNT field by one.

If increasing the counter would result in an overflow, returns an error.

pub fn dec_qdcount(&mut self)

Decreases the value of the QDCOUNT field by one.

Panics

This method panics if the count is already zero.

pub fn ancount(self) -> u16

Returns the value of the ANCOUNT field.

This field contains the number of resource records in the second section of the message, normally the answer section.

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

Sets the value of the ANCOUNT field.

pub fn inc_ancount(&mut self) -> Result<(), CountOverflow>

Increases the value of the ANCOUNT field by one.

If increasing the counter would result in an overflow, returns an error.

pub fn dec_ancount(&mut self)

Decreases the value of the ANCOUNT field by one.

Panics

This method panics if the count is already zero.

pub fn nscount(self) -> u16

Returns the value of the NSCOUNT field.

This field contains the number of resource records in the third section of the message, normally the authority section.

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

Sets the value of the NSCOUNT field.

pub fn inc_nscount(&mut self) -> Result<(), CountOverflow>

Increases the value of the NSCOUNT field by one.

If increasing the counter would result in an overflow, returns an error.

pub fn dec_nscount(&mut self)

Decreases the value of the NSCOUNT field by one.

Panics

This method panics if the count is already zero.

pub fn arcount(self) -> u16

Returns the value of the ARCOUNT field.

This field contains the number of resource records in the fourth section of the message, normally the additional section.

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

Sets the value of the ARCOUNT field.

pub fn inc_arcount(&mut self) -> Result<(), CountOverflow>

Increases the value of the ARCOUNT field by one.

If increasing the counter would result in an overflow, returns an error.

pub fn dec_arcount(&mut self)

Decreases the value of the ARCOUNT field by one.

Panics

This method panics if the count is already zero.

pub fn zocount(self) -> u16

Returns the value of the ZOCOUNT field.

This is the same as the qdcount(). It is used in UPDATE queries where the first section is the zone section.

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

Sets the value of the ZOCOUNT field.

pub fn prcount(self) -> u16

Returns the value of the PRCOUNT field.

This is the same as the ancount(). It is used in UPDATE queries where the first section is the prerequisite section.

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

Sete the value of the PRCOUNT field.

pub fn upcount(self) -> u16

Returns the value of the UPCOUNT field.

This is the same as the nscount(). It is used in UPDATE queries where the first section is the update section.

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

Sets the value of the UPCOUNT field.

pub fn adcount(self) -> u16

Returns the value of the ADCOUNT field.

This is the same as the arcount(). It is used in UPDATE queries where the first section is the additional section.

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

Sets the value of the ADCOUNT field.

Trait Implementations

impl AsMut<HeaderCounts> for HeaderSection

fn as_mut(&mut self) -> &mut HeaderCounts

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

impl AsRef<HeaderCounts> for HeaderSection

fn as_ref(&self) -> &HeaderCounts

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

impl Clone for HeaderCounts

fn clone(&self) -> HeaderCounts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderCounts

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

Formats the value using the given formatter.

impl Default for HeaderCounts

fn default() -> HeaderCounts

Returns the “default value” for a type.

impl PartialEq<HeaderCounts> for HeaderCounts

fn eq(&self, other: &HeaderCounts) -> 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 Copy for HeaderCounts

impl Eq for HeaderCounts

impl StructuralEq for HeaderCounts

impl StructuralPartialEq for HeaderCounts