Struct domain::base::record::Record

pub struct Record<Name, Data> { /* fields omitted */ }

A DNS resource record.

All information available through the DNS is stored in resource records. They have a three part key of a domain name, resource record type, and class. Data is arranged in a tree which is navigated using the domain name. Each node in the tree carries a label, starting with the root label as the top-most node. The tree is traversed by stepping through the name from right to left, finding a child node carring the label of each step. The domain name resulting from this traversal is part of the record itself. It is called the owner of the record.

The record type describes the kind of data the record holds, such as IP addresses. The class, finally, describes which sort of network the information is for. The DNS was originally intended to be used for networks other than the Internet as well. In practice, the only relevant class is IN, the Internet. Note that each class has its own tree of nodes.

The payload of a resource record is its data. Its purpose, meaning, and format is determined by the record type (technically, also its class). For each unique three-part key there can be multiple resource records. All these records for the same key are called resource record sets, most often shortened to ‘RRset.’

There is one more piece of data: the TTL or time to live. This value says how long a record remains valid before it should be refreshed from its original source, given in seconds. The TTL is used to add caching facilities to the DNS.

Values of the Record type represent one single resource record. Since there are currently more than eighty record types—see Rtype for a complete list—, the type is generic over a trait for record data. This trait holds both the record type value and the record data as they are inseparably entwined.

Because a record’s owner is a domain name, the Record type is additionally generic over the domain name type is for it.

There is three ways to create a record value. First, you can make one yourself using the new function. It will neatly take care of all the generics through type inference. Secondly, you can parse a record from an existing message. Message and its friends provide a way to do that; see there for all the details. Finally, you can scan a record from master data (aka zonefiles). See the domain::master module for that.

Implementations

impl<Name, Data> Record<Name, Data>

Creation and Element Access

pub fn new(owner: Name, class: Class, ttl: u32, data: Data) -> Self

Creates a new record from its parts.

pub fn from_record<NN, DD>(record: Record<NN, DD>) -> Self where
    Name: From<NN>,
    Data: From<DD>, 

Creates a new record from a compatible record.

This function only exists because the equivalent From implementation is currently not possible,

pub fn owner(&self) -> &Name

Returns a reference to the owner domain name.

The owner of a record is the domain name that specifies the node in the DNS tree this record belongs to.

pub fn rtype(&self) -> Rtype where
    Data: RecordData, 

Returns the record type.

pub fn class(&self) -> Class

Returns the record class.

pub fn set_class(&mut self, class: Class)

Sets the record’s class.

pub fn ttl(&self) -> u32

Returns the record’s time-to-live.

pub fn set_ttl(&mut self, ttl: u32)

Sets the record’s time-to-live.

pub fn data(&self) -> &Data

Return a reference to the record data.

pub fn data_mut(&mut self) -> &mut Data

Returns a mutable reference to the record data.

pub fn into_data(self) -> Data

Trades the record for its record data.

Trait Implementations

impl<Name: ToDname, Data: RecordData> AsRecord for Record<Name, Data>

type Name = Name

The type of the record’s owner domain name.

type Data = Data

The type of the record data.

fn owner(&self) -> &Self::Name

Returns a reference to the owner domain name.

fn class(&self) -> Class

Returns the record’s class.

fn ttl(&self) -> u32

Returns the record’s TTL:

fn data(&self) -> &Self::Data

Returns a reference to the record data.

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

Produces the encoded record.

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

Produces the canonically encoded record.

impl<N, NN, D, DD> CanonicalOrd<Record<NN, DD>> for Record<N, D> where
    N: ToDname,
    NN: ToDname,
    D: RecordData + CanonicalOrd<DD>,
    DD: RecordData, 

fn canonical_cmp(&self, other: &Record<NN, DD>) -> Ordering

Returns the canonical ordering between self and other.

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

Returns whether self is canonically less than other.

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

Returns whether self is canonically less than or equal to other.

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

Returns whether self is canonically greater than other.

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

Returns whether self is canonically greater than or equal to other.

impl<Name: Clone, Data: Clone> Clone for Record<Name, Data>

fn clone(&self) -> Record<Name, Data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: ToDname, D: RecordData> Compose for Record<N, D>

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, Data> Debug for Record<Name, Data> where
    Name: Debug,
    Data: Debug, 

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

Formats the value using the given formatter.

impl<Name, Data> Display for Record<Name, Data> where
    Name: Display,
    Data: RecordData + Display, 

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

Formats the value using the given formatter.

impl<N: Eq, D: RecordData + Eq> Eq for Record<N, D>

impl<N, D> From<(N, Class, u32, D)> for Record<N, D>

fn from((owner, class, ttl, data): (N, Class, u32, D)) -> Self

Performs the conversion.

impl<N, D> From<(N, u32, D)> for Record<N, D>

fn from((owner, ttl, data): (N, u32, D)) -> Self

Performs the conversion.

impl<Octets, N: ToDname> From<Record<N, Opt<Octets>>> for OptRecord<Octets>

fn from(record: Record<N, Opt<Octets>>) -> Self

Performs the conversion.

impl<Name, Data> Hash for Record<Name, Data> where
    Name: Hash,
    Data: Hash, 

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<N, D> Ord for Record<N, D> where
    N: Ord,
    D: RecordData + Ord, 

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<N, NN, D, DD> PartialEq<Record<NN, DD>> for Record<N, D> where
    N: PartialEq<NN>,
    D: RecordData + PartialEq<DD>,
    DD: RecordData, 

fn eq(&self, other: &Record<NN, DD>) -> 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<N, NN, D, DD> PartialOrd<Record<NN, DD>> for Record<N, D> where
    N: PartialOrd<NN>,
    D: RecordData + PartialOrd<DD>,
    DD: RecordData, 

fn partial_cmp(&self, other: &Record<NN, DD>) -> 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.