Struct domain::base::record::RecordHeader

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

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: u32,
    rdlen: u16
) -> Self

Creates a new record header from its components.

impl<Name> RecordHeader<Name>

pub fn parse_and_skip<Ref>(parser: &mut Parser<Ref>) -> Result<Self, ParseError> where
    Self: Parse<Ref>,
    Ref: OctetsRef, 

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<Ref: OctetsRef> RecordHeader<ParsedDname<Ref>>

pub fn parse_into_record<Data>(
    self,
    parser: &mut Parser<Ref>
) -> Result<Option<Record<ParsedDname<Ref>, Data>>, ParseError> where
    Data: ParseRecordData<Ref>, 

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> 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) -> u32

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.

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: Compose> Compose for RecordHeader<Name>

fn compose<T: OctetsBuilder>(&self, target: &mut T) -> Result<(), ShortBuf>

Appends the concrete representation of the value to the target.

fn compose_canonical<T: OctetsBuilder>(
    &self,
    target: &mut T
) -> Result<(), ShortBuf>

Appends the canonical representation of the value to the target.

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

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

Formats the value using the given formatter.

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

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, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Ref: OctetsRef> Parse<Ref> for RecordHeader<ParsedDname<Ref>>

fn parse(parser: &mut Parser<Ref>) -> Result<Self, ParseError>

Extracts a value from the beginning of parser.

fn skip(parser: &mut Parser<Ref>) -> Result<(), ParseError>

Skips over a value of this type at the beginning of parser.

impl<Name, NName> PartialEq<RecordHeader<NName>> for RecordHeader<Name> where
    Name: ToDname,
    NName: ToDname, 

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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.

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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