Struct domain::base::record::RecordHeader

pub struct RecordHeader<Name> { /* private fields */ }

The header of a resource record.

This type encapsulates the common header of a resource record. It consists of the owner, record type, class, TTL, and the length of the record data. It is effectively a helper type for dealing with resource records encoded in a DNS message.

See Record for more details about resource records.

Implementations

impl<Name> RecordHeader<Name>

pub fn new( owner: Name, rtype: Rtype, class: Class, ttl: Ttl, rdlen: u16, ) -> Self

Creates a new record header from its components.

impl<Name> RecordHeader<Name>

pub fn owner(&self) -> &Name

Returns a reference to the owner of the record.

pub fn rtype(&self) -> Rtype

Returns the record type of the record.

pub fn class(&self) -> Class

Returns the class of the record.

pub fn ttl(&self) -> Ttl

Returns the TTL of the record.

pub fn rdlen(&self) -> u16

Returns the data length of the record.

pub fn into_record<Data>(self, data: Data) -> Record<Name, Data>

Converts the header into an actual record.

impl<Octs> RecordHeader<ParsedDname<Octs>>

Parsing and Composing

pub fn parse<'a, Src: Octets<Range<'a> = Octs>>( parser: &mut Parser<'a, Src>, ) -> Result<Self, ParseError>

impl<'a, Octs: AsRef<[u8]> + ?Sized> RecordHeader<ParsedDname<&'a Octs>>

pub fn parse_ref(parser: &mut Parser<'a, Octs>) -> Result<Self, ParseError>

impl<Name> RecordHeader<Name>

pub fn parse_and_skip<'a, Octs>( parser: &mut Parser<'a, Octs>, ) -> Result<Self, ParseError>

where Self: Parse<'a, Octs>, Octs: Octets,

Parses a record header and then skips over the data.

If the function succeeds, the parser will be positioned right behind the end of the record.

impl<Octs> RecordHeader<ParsedDname<Octs>>

pub fn parse_into_record<'a, Src, Data>( self, parser: &mut Parser<'a, Src>, ) -> Result<Option<Record<ParsedDname<Octs>, Data>>, ParseError>

where Src: AsRef<[u8]> + ?Sized, Data: ParseRecordData<'a, Src>,

Parses the remainder of the record and returns it.

The method assumes that the parsers is currently positioned right after the end of the record header. If the record data type D feels capable of parsing a record with a header of self, the method will parse the data and return a full Record<D>. Otherwise, it skips over the record data.

impl<Name: ToDname> RecordHeader<Name>

pub fn compose<Target: Composer + ?Sized>( &self, buf: &mut Target, ) -> Result<(), Target::AppendError>

pub fn compose_canonical<Target: Composer + ?Sized>( &self, buf: &mut Target, ) -> Result<(), Target::AppendError>

Trait Implementations

impl<Name: Clone> Clone for RecordHeader<Name>

fn clone(&self) -> RecordHeader<Name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Name: Debug> Debug for RecordHeader<Name>

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

Formats the value using the given formatter.

impl<Name: Hash> Hash for RecordHeader<Name>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Name: ToDname> Ord for RecordHeader<Name>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<Name, NName> PartialEq<RecordHeader<NName>> for RecordHeader<Name>

where Name: ToDname, NName: ToDname,

fn eq(&self, other: &RecordHeader<NName>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Name, NName> PartialOrd<RecordHeader<NName>> for RecordHeader<Name>

where Name: ToDname, NName: ToDname,

fn partial_cmp(&self, other: &RecordHeader<NName>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Name: ToDname> Eq for RecordHeader<Name>