Struct RecordHeader

pub struct RecordHeader<N> { /* 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<N> RecordHeader<N>

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

Creates a new record header from its components.

impl RecordHeader<ParsedDname>

pub fn parse_and_skip(parser: &mut Parser) -> Result<Self, ParsedDnameError>

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.

pub fn parse_into_record<D: ParseRecordData>( self, parser: &mut Parser, ) -> Result<Option<Record<ParsedDname, D>>, RecordParseError<ParsedDnameError, D::Err>>

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<N: ToDname> RecordHeader<N>

pub fn owner(&self) -> &N

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<D: RecordData>(self, data: D) -> Record<N, D>

Converts the header into an actual record.

Trait Implementations

impl<N: Clone> Clone for RecordHeader<N>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Compose> Compose for RecordHeader<N>

fn compose_len(&self) -> usize

Returns the number of bytes this value will need without compression.

fn compose<B: BufMut>(&self, buf: &mut B)

Appends the uncompressed representation of this value to buf.

impl<N: Compress> Compress for RecordHeader<N>

fn compress(&self, buf: &mut Compressor) -> Result<(), ShortBuf>

Appends the wire-format representation of the value to buf.

impl<N: Debug> Debug for RecordHeader<N>

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

Formats the value using the given formatter.

impl Parse for RecordHeader<ParsedDname>

type Err = ParsedDnameError

The type of an error returned when parsing fails.

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

Extracts a value from the beginning of parser.

fn skip(parser: &mut Parser) -> Result<(), Self::Err>

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

impl<N: PartialEq> PartialEq for RecordHeader<N>

fn eq(&self, other: &RecordHeader<N>) -> 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<N: Eq> Eq for RecordHeader<N>

impl<N> StructuralPartialEq for RecordHeader<N>