Struct trust_dns_proto::rr::RecordSet

pub struct RecordSet { /* fields omitted */ }

Set of resource records associated to a name and type

Methods

impl RecordSet

pub fn new(name: &Name, record_type: RecordType, serial: u32) -> Self

Creates a new Resource Record Set.

Arguments

• name - The label for the RecordSet
• record_type - RecordType of this RecordSet, all records in the RecordSet must be of the specified RecordType.
• serial - current serial number of the SOA record, this is to be used for IXFR and signing for DNSSec after updates.

Return value

The newly created Resource Record Set TODO: make all cloned params pass by value

pub fn with_ttl(name: Name, record_type: RecordType, ttl: u32) -> Self

Creates a new Resource Record Set.

Arguments

• name - The label for the RecordSet
• record_type - RecordType of this RecordSet, all records in the RecordSet must be of the specified RecordType.
• ttl - time-to-live for the RecordSet in seconds.

Return value

The newly created Resource Record Set TODO: make all cloned params pass by value

pub fn from(record: Record) -> Self

Creates a new Resource Record Set from a Record

Arguments

• record - initializes a record set with a single record

Return value

The newly created Resource Record Set

pub fn name(&self) -> &Name

Return value

Label of the Resource Record Set

pub fn record_type(&self) -> RecordType

Return value

RecordType of the Resource Record Set

pub fn set_dns_class(&mut self, dns_class: DNSClass)

Sets the DNSClass to the specified value

This will traverse every record and associate with it the specified dns_class

pub fn dns_class(&self) -> DNSClass

Returns the DNSClass of the RecordSet

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

Sets the TTL, in seconds, to the specified value

This will traverse every record and associate with it the specified ttl

pub fn ttl(&self) -> u32

Returns the time-to-live for the record.

Return value

TTL, time-to-live, of the Resource Record Set, this is the maximum length of time that an RecordSet should be cached.

Important traits for RrsetRecords<'r>

impl<'r> Iterator for RrsetRecords<'r> type Item = &'r Record;

pub fn records_without_rrsigs<'s>(&'s self) -> RrsetRecords<'s>

Returns a Vec of all records in the set, without any RRSIGs.

pub fn iter<'s>(&'s self) -> Iter<'s, Record>

Deprecated:

see records_without_rrsigs

Returns an iterator over the records in the set

pub fn is_empty(&self) -> bool

Returns true if there are no records in this set

pub fn serial(&self) -> u32

Returns the serial number at which the record was updated.

pub fn rrsigs(&self) -> &[Record]

Returns a slice of all the Records signatures in the RecordSet

pub fn insert_rrsig(&mut self, rrsig: Record)

Inserts a Signature for the Record set

Many can be associated with the RecordSet. Once added, the RecordSet should not be changed

Arguments

• rrsig - A signature which covers the RecordSet.

pub fn clear_rrsigs(&mut self)

Useful for clearing all signatures when the RecordSet is updated, or keys are rotated.

pub fn new_record(&mut self, rdata: &RData) -> &Record

creates a new Record as part of this RecordSet, adding the associated RData

pub fn insert(&mut self, record: Record, serial: u32) -> bool

Inserts a new Resource Record into the Set.

If the record is inserted, the ttl for the most recent record will be used for the ttl of the entire resource record set.

This abides by the following restrictions in RFC 2136, April 1997:

1.1.5. The following RR types cannot be appended to an RRset.  If the
 following comparison rules are met, then an attempt to add the new RR
 will result in the replacement of the previous RR:

SOA    compare only NAME, CLASS and TYPE -- it is not possible to
        have more than one SOA per zone, even if any of the data
        fields differ.

CNAME  compare only NAME, CLASS, and TYPE -- it is not possible
        to have more than one CNAME RR, even if their data fields
        differ.

Arguments

• record - Record asserts that the name and record_type match the RecordSet.
• serial - current serial number of the SOA record, this is to be used for IXFR and signing for DNSSec after updates. The serial will only be updated if the record was added.

Return value

True if the record was inserted.

TODO: make a default add without serial number for basic usage

pub fn remove(&mut self, record: &Record, serial: u32) -> bool

Removes the Resource Record if it exists.

Arguments

• record - Record asserts that the name and record_type match the RecordSet. Removes any record if the record data, RData, match.
• serial - current serial number of the SOA record, this is to be used for IXFR and signing for DNSSec after updates. The serial will only be updated if the record was added.

Return value

True if a record was removed.

Trait Implementations

impl IntoRecordSet for RecordSet

fn into_record_set(self) -> Self

Performs the conversion to a RecordSet

impl Clone for RecordSet

fn clone(&self) -> RecordSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<RecordSet> for RecordSet

fn eq(&self, other: &RecordSet) -> bool

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

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

This method tests for !=.

impl IntoIterator for RecordSet

type Item = Record

The type of the elements being iterated over.

type IntoIter = Chain<IntoIter<Record>, IntoIter<Record>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for RecordSet

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

Formats the value using the given formatter.