Struct domain::base::record::Record

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

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. 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 zone file format. See the crate’s zonefile module for that.

Implementations

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

Creation and Element Access

pub fn new(owner: Name, class: Class, ttl: Ttl, 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) -> Ttl

Returns the record’s time-to-live.

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

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.

pub fn into_owner_and_data(self) -> (Name, Data)

Trades the record for its owner name and data.

impl<Octs, Data> Record<ParsedName<Octs>, Data>

Parsing and Composing

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

where Data: ParseRecordData<'a, Src>,

impl<N: ToName, D: RecordData + ComposeRecordData> Record<N, D>

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

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

Trait Implementations

impl<N, D> AsRef<Record<N, D>> for Record<N, D>

fn as_ref(&self) -> &Record<N, D>

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

impl<N, NN, D, DD> CanonicalOrd<Record<NN, DD>> for Record<N, D>

where N: ToName, NN: ToName, D: RecordData + CanonicalOrd<DD>, DD: RecordData,

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

Returns the canonical ordering between self and other.

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

Returns whether self is canonically less than other.

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

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

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

Returns whether self is canonically greater than other.

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<Name, Data> ComposeRecord for Record<Name, Data>

where Name: ToName, Data: ComposeRecordData,

fn compose_record<Target: Composer + ?Sized>( &self, target: &mut Target ) -> Result<(), Target::AppendError>

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<'de, Name, Data> Deserialize<'de> for Record<Name, Data>

where Name: Deserialize<'de>, Data: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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, D> Extend<Record<N, D>> for SortedRecords<N, D>

where N: ToName, D: RecordData + CanonicalOrd,

Available on crate feature sign only.

fn extend<T: IntoIterator<Item = Record<N, D>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<Name, TName, Data, TData> FlattenInto<Record<TName, TData>> for Record<Name, Data>

where Name: FlattenInto<TName>, Data: FlattenInto<TData, AppendError = Name::AppendError>,

type AppendError = <Name as FlattenInto<TName>>::AppendError

fn try_flatten_into(self) -> Result<Record<TName, TData>, Name::AppendError>

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<Octs, N: ToName> From<Record<N, Opt<Octs>>> for OptRecord<Octs>

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

Converts to this type from the input type.

impl From<Record<Name<Bytes>, ZoneRecordData<Bytes, Name<Bytes>>>> for Rrset

Available on crate feature unstable-zonetree only.

fn from(record: StoredRecord) -> Self

Converts to this type from the input type.

impl From<Record<Name<Bytes>, ZoneRecordData<Bytes, Name<Bytes>>>> for SharedRr

Available on crate feature unstable-zonetree only.

fn from(record: StoredRecord) -> Self

Converts to this type from the input type.

impl<N, D> FromIterator<Record<N, D>> for SortedRecords<N, D>

where N: ToName, D: RecordData + CanonicalOrd,

Available on crate feature sign only.

fn from_iter<T: IntoIterator<Item = Record<N, D>>>(iter: T) -> Self

Creates a value from an iterator.

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

Feeds a slice of this type into the given Hasher.

impl<Name, Data, SrcName, SrcData> OctetsFrom<Record<SrcName, SrcData>> for Record<Name, Data>

where Name: OctetsFrom<SrcName>, Data: OctetsFrom<SrcData>, Data::Error: From<Name::Error>,

type Error = <Data as OctetsFrom<SrcData>>::Error

fn try_octets_from( source: Record<SrcName, SrcData> ) -> Result<Self, Self::Error>

Performs the conversion.

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.

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<N: ToName, NN: ToName, D> PartialEq<Record<NN, D>> for FamilyName<N>

Available on crate feature sign only.

fn eq(&self, other: &Record<NN, D>) -> 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<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 ==.

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<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.

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

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

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

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

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

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

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

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

impl<Name, Data> Serialize for Record<Name, Data>

where Name: Serialize, Data: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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