pub struct RecordSet { /* private fields */ }Expand description
Set of resource records associated to a name and type
Implementations
sourceimpl RecordSet
impl RecordSet
sourcepub fn new(name: &Name, record_type: RecordType, serial: u32) -> RecordSet
pub fn new(name: &Name, record_type: RecordType, serial: u32) -> RecordSet
Creates a new Resource Record Set.
Arguments
name- The label for theRecordSetrecord_type-RecordTypeof thisRecordSet, all records in theRecordSetmust be of the specifiedRecordType.serial- current serial number of theSOArecord, this is to be used forIXFRand signing for DNSSec after updates.
Return value
The newly created Resource Record Set TODO: make all cloned params pass by value
sourcepub fn with_ttl(name: Name, record_type: RecordType, ttl: u32) -> RecordSet
pub fn with_ttl(name: Name, record_type: RecordType, ttl: u32) -> RecordSet
Creates a new Resource Record Set.
Arguments
name- The label for theRecordSetrecord_type-RecordTypeof thisRecordSet, all records in theRecordSetmust be of the specifiedRecordType.ttl- time-to-live for theRecordSetin seconds.
Return value
The newly created Resource Record Set TODO: make all cloned params pass by value
sourcepub fn from(record: Record) -> RecordSet
pub fn from(record: Record) -> RecordSet
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
sourcepub fn name(&self) -> &Name
pub fn name(&self) -> &Name
Return value
Label of the Resource Record Set
sourcepub fn record_type(&self) -> RecordType
pub fn record_type(&self) -> RecordType
Return value
RecordType of the Resource Record Set
sourcepub fn set_dns_class(&mut self, dns_class: DNSClass)
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
sourcepub fn set_ttl(&mut self, ttl: u32)
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
sourcepub fn ttl(&self) -> u32
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.
sourcepub fn records<'s>(
&'s self,
and_rrsigs: bool,
supported_algorithms: SupportedAlgorithms
) -> RrsetRecords<'s>
pub fn records<'s>(
&'s self,
and_rrsigs: bool,
supported_algorithms: SupportedAlgorithms
) -> RrsetRecords<'s>
Returns a Vec of all records in the set.
Arguments
and_rrsigs- if true, RRSIGs will be returned if they existsupported_algorithms- the RRSIGs will be filtered by the set of supported_algorithms, and then only the maximal RRSIG algorithm will be returned.
sourcepub fn records_with_rrsigs<'s>(
&'s self,
supported_algorithms: SupportedAlgorithms
) -> RrsetRecords<'s>
pub fn records_with_rrsigs<'s>(
&'s self,
supported_algorithms: SupportedAlgorithms
) -> RrsetRecords<'s>
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.
sourcepub fn records_without_rrsigs<'s>(&'s self) -> RrsetRecords<'s>
pub fn records_without_rrsigs<'s>(&'s self) -> RrsetRecords<'s>
Returns a Vec of all records in the set, without any RRSIGs.
sourcepub fn iter<'s>(&'s self) -> Iter<'s, Record>
👎Deprecated: see records_without_rrsigs
pub fn iter<'s>(&'s self) -> Iter<'s, Record>
records_without_rrsigsReturns an iterator over the records in the set
sourcepub fn rrsigs(&self) -> &[Record]
pub fn rrsigs(&self) -> &[Record]
Returns a slice of all the Records signatures in the RecordSet
sourcepub fn insert_rrsig(&mut self, rrsig: Record)
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.
sourcepub fn clear_rrsigs(&mut self)
pub fn clear_rrsigs(&mut self)
Useful for clearing all signatures when the RecordSet is updated, or keys are rotated.
sourcepub fn new_record(&mut self, rdata: &RData) -> &Record
pub fn new_record(&mut self, rdata: &RData) -> &Record
creates a new Record as part of this RecordSet, adding the associated RData
sourcepub fn insert(&mut self, record: Record, serial: u32) -> bool
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-Recordasserts that thenameandrecord_typematch theRecordSet.serial- current serial number of theSOArecord, this is to be used forIXFRand 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
sourcepub fn remove(&mut self, record: &Record, serial: u32) -> bool
pub fn remove(&mut self, record: &Record, serial: u32) -> bool
Removes the Resource Record if it exists.
Arguments
record-Recordasserts that thenameandrecord_typematch theRecordSet. Removes anyrecordif the record data,RData, match.serial- current serial number of theSOArecord, this is to be used forIXFRand signing for DNSSec after updates. The serial will only be updated if the record was added.
Return value
True if a record was removed.