Struct Zone

pub struct Zone {
    apex: DomainName,
    soa: Option<SOA>,
    records: ZoneRecords,
}

A zone is a collection of records all belonging to the same domain name.

Fields

apex: DomainName

The domain name which the records all belong to.

soa: Option<SOA>

The SOA record for this zone, if it is authoritative.

records: ZoneRecords

Records. These are indexed by label, with the labels relative to the apex. For example, if the apex is “barrucadu.co.uk”, then records for “www.barrucadu.co.uk” would be indexed under “www”.

Implementations

impl Zone

pub fn deserialise(data: &str) -> Result<Self, Error>

Parse a string of zone data

This implementation does not support $INCLUDE entries or non-IN record classes. These will raise an error.

Errors

If the string cannot be parsed.

impl Zone

pub fn serialise(&self) -> String

fn serialise_domain(&self, name: &DomainName) -> String

Serialise a domain name: dotted string format, with the apex chopped off if this is an authoritative zone (unless the apex is the root domain, because that’s only a single character long so we may as well show it).

pub fn serialise_rdata(&self, rtype_with_data: &RecordTypeWithData) -> String

Serialise the RDATA, with domains displayed relative to the apex (if authoritative).

impl Zone

pub fn new(apex: DomainName, soa: Option<SOA>) -> Self

Construct a new zone.

If there is a SOA value, it is inserted as an RR at the root of the zone.

pub fn get_apex(&self) -> &DomainName

Returns the apex domain.

pub fn get_soa(&self) -> Option<&SOA>

Return the SOA if the zone is authoritative.

pub fn is_authoritative(&self) -> bool

Returns true if the zone is authoritative.

pub fn soa_rr(&self) -> Option<ResourceRecord>

Returns the SOA RR if the zone is authoritative.

pub fn resolve(&self, name: &DomainName, qtype: QueryType) -> Option<ZoneResult>

Resolve a query. Returns None if the domain is not a subdomain of the apex.

This corresponds to step 3 of the standard nameserver algorithm (see section 4.3.2 of RFC 1034).

pub fn insert( &mut self, name: &DomainName, rtype_with_data: RecordTypeWithData, ttl: u32, )

Insert a record for a domain. This domain MUST be a subdomain of the apex.

Note that, for authoritative zones, the SOA minimum field is a lower bound on the TTL of any RR in the zone. So if this TTL is lower, it will be raised.

pub fn insert_wildcard( &mut self, name: &DomainName, rtype_with_data: RecordTypeWithData, ttl: u32, )

Insert a wildcard record for a domain. This domain MUST be a subdomain of the apex.

Note that, for authoritative zones, the SOA minimum field is a lower bound on the TTL of any RR in the zone. So if this TTL is lower, it will be raised.

pub fn relative_domain<'a>(&self, name: &'a DomainName) -> Option<&'a [Label]>

Take a domain and chop off the suffix corresponding to the apex of this zone.

Returns None if the given domain does not match the apex.

pub fn actual_ttl(&self, ttl: u32) -> u32

If this zone is authoritative, and the given TTL is below the SOA minimum field, returns the SOA minimum field.

Otherwise returns the given TTL.

pub fn merge(&mut self, other: Zone) -> Result<(), (DomainName, DomainName)>

Merge another zone into this one.

Errors

If the apex does not match.

pub fn all_records(&self) -> HashMap<&DomainName, Vec<&ZoneRecord>>

Return all the records in the zone.

pub fn all_wildcard_records(&self) -> HashMap<&DomainName, Vec<&ZoneRecord>>

Return all the wildcard records in the zone.

Trait Implementations

impl Clone for Zone

fn clone(&self) -> Zone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Zone

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

Formats the value using the given formatter.

impl Default for Zone

fn default() -> Self

Returns the “default value” for a type.

impl From<Hosts> for Zone

fn from(hosts: Hosts) -> Zone

Converts to this type from the input type.

impl PartialEq for Zone

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Zone> for Hosts

fn try_from(zone: Zone) -> Result<Self, Self::Error>

Errors

If the zone has wildcard domain names or non-A / non-AAAA record types.

type Error = TryFromZoneError

The type returned in the event of a conversion error.

impl Eq for Zone

impl StructuralPartialEq for Zone