Struct hickory_proto::rr::RecordSet

source ·

pub struct RecordSet { /* private fields */ }

Expand description

Set of resource records associated to a name and type

Implementations§

source §

impl RecordSet

source

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

source

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

source

pub fn name(&self) -> &Name

§Return value

Label of the Resource Record Set

source

pub fn record_type(&self) -> RecordType

§Return value

RecordType of the Resource Record Set

source

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

source

pub fn dns_class(&self) -> DNSClass

Returns the DNSClass of the RecordSet

source

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

source

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.

source

pub fn records( &self, and_rrsigs: bool, supported_algorithms: SupportedAlgorithms ) -> RrsetRecords<'_> ⓘ

Available on crate feature dnssec only.

Returns a Vec of all records in the set.

§Arguments

and_rrsigs - if true, RRSIGs will be returned if they exist
supported_algorithms - the RRSIGs will be filtered by the set of supported_algorithms, and then only the maximal RRSIG algorithm will be returned.

source

pub fn records_with_rrsigs( &self, supported_algorithms: SupportedAlgorithms ) -> RrsetRecords<'_> ⓘ

Available on crate feature dnssec only.

Returns a Vec of all records in the set, with RRSIGs, if present.

§Arguments

supported_algorithms - the RRSIGs will be filtered by the set of supported_algorithms, and then only the maximal RRSIG algorithm will be returned.

source

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

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

source

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

👎Deprecated: see records_without_rrsigs

Returns an iterator over the records in the set

source

pub fn is_empty(&self) -> bool

Returns true if there are no records in this set

source

pub fn serial(&self) -> u32

Returns the serial number at which the record was updated.

source

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

Returns a slice of all the Records signatures in the RecordSet

source

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.

source

pub fn clear_rrsigs(&mut self)

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

source

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

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

this interface may be deprecated in the future.

source

pub fn add_rdata(&mut self, rdata: RData) -> bool

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

source

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

source

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.