Struct hickory_proto::rr::rdata::soa::SOA

pub struct SOA { /* private fields */ }

RFC 1035, DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION, November 1987

3.3.13. SOA RDATA format

    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    /                     MNAME                     /
    /                                               /
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    /                     RNAME                     /
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    |                    SERIAL                     |
    |                                               |
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    |                    REFRESH                    |
    |                                               |
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    |                     RETRY                     |
    |                                               |
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    |                    EXPIRE                     |
    |                                               |
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
    |                    MINIMUM                    |
    |                                               |
    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+

where:

SOA records cause no additional section processing.

All times are in units of seconds.

Most of these fields are pertinent only for name server maintenance
operations.  However, MINIMUM is used in all query operations that
retrieve RRs from a zone.  Whenever a RR is sent in a response to a
query, the TTL field is set to the maximum of the TTL field from the RR
and the MINIMUM field in the appropriate SOA.  Thus MINIMUM is a lower
bound on the TTL field for all RRs in a zone.  Note that this use of
MINIMUM should occur when the RRs are copied into the response and not
when the zone is loaded from a Zone File or via a zone transfer.  The
reason for this provision is to allow future dynamic update facilities to
change the SOA RR with known semantics.

Implementations

impl SOA

pub fn new( mname: Name, rname: Name, serial: u32, refresh: i32, retry: i32, expire: i32, minimum: u32, ) -> Self

Creates a new SOA record data.

Arguments

• mname - the name of the primary or authority for this zone.
• rname - the name of the responsible party for this zone, e.g. an email address.
• serial - the serial number of the zone, used for caching purposes.
• refresh - the amount of time to wait before a zone is resynched.
• retry - the minimum period to wait if there is a failure during refresh.
• expire - the time until this primary is no longer authoritative for the zone.
• minimum - no zone records should have time-to-live values less than this minimum.

Return value

The newly created SOA record data.

pub fn increment_serial(&mut self)

Increments the serial number by one

pub fn mname(&self) -> &Name

MNAME           The <domain-name> of the name server that was the
                original or primary source of data for this zone.

Return value

The domain-name of the name server that was the original or primary source of data for this zone, i.e. the Primary Name Server.

pub fn rname(&self) -> &Name

RNAME           A <domain-name> which specifies the mailbox of the
                person responsible for this zone.

Return value

A domain-name which specifies the mailbox of the person responsible for this zone, i.e. the responsible name.

pub fn serial(&self) -> u32

SERIAL          The unsigned 32 bit version number of the original copy
                of the zone.  Zone transfers preserve this value.  This
                value wraps and should be compared using sequence space
                arithmetic.

Return value

The unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this value. This value wraps and should be compared using sequence space arithmetic.

pub fn refresh(&self) -> i32

REFRESH         A 32 bit time interval before the zone should be
                refreshed.

Return value

A 32 bit time interval before the zone should be refreshed, in seconds.

pub fn retry(&self) -> i32

RETRY           A 32 bit time interval that should elapse before a
                failed refresh should be retried.

Return value

A 32 bit time interval that should elapse before a failed refresh should be retried, in seconds.

pub fn expire(&self) -> i32

EXPIRE          A 32 bit time value that specifies the upper limit on
                the time interval that can elapse before the zone is no
                longer authoritative.

Return value

A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative, in seconds

pub fn minimum(&self) -> u32

MINIMUM         The unsigned 32 bit minimum TTL field that should be
                exported with any RR from this zone.

Return value

The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.

Trait Implementations

impl<'r> BinDecodable<'r> for SOA

fn read(decoder: &mut BinDecoder<'r>) -> ProtoResult<Self>

Read the type from the stream

fn from_bytes(bytes: &'r [u8]) -> ProtoResult<Self>

Returns the object in binary form

impl BinEncodable for SOA

fn emit(&self, encoder: &mut BinEncoder<'_>) -> ProtoResult<()>

RFC 4034, DNSSEC Resource Records, March 2005

This is accurate for all currently known name records.

6.2.  Canonical RR Form

   For the purposes of DNS security, the canonical form of an RR is the
   wire format of the RR where:

   ...

   3.  if the type of the RR is NS, MD, MF, CNAME, SOA, MB, MG, MR, PTR,
       HINFO, MINFO, MX, HINFO, RP, AFSDB, RT, SIG, PX, NXT, NAPTR, KX,
       SRV, DNAME, A6, RRSIG, or (rfc6840 removes NSEC), all uppercase
       US-ASCII letters in the DNS names contained within the RDATA are replaced
       by the corresponding lowercase US-ASCII letters;

fn to_bytes(&self) -> ProtoResult<Vec<u8>>

Returns the object in binary form

impl Clone for SOA

fn clone(&self) -> SOA

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SOA

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SOA

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SOA

RFC 1033, DOMAIN OPERATIONS GUIDE, November 1987

SOA  (Start Of Authority)

<name>  [<ttl>]  [<class>]  SOA  <origin>  <person>  (
   <serial>
   <refresh>
   <retry>
   <expire>
   <minimum> )

The Start Of Authority record designates the start of a zone.  The
zone ends at the next SOA record.

<name> is the name of the zone.

<origin> is the name of the host on which the master zone file
resides.

<person> is a mailbox for the person responsible for the zone.  It is
formatted like a mailing address but the at-sign that normally
separates the user from the host name is replaced with a dot.

<serial> is the version number of the zone file.  It should be
incremented anytime a change is made to data in the zone.

<refresh> is how long, in seconds, a secondary name server is to
check with the primary name server to see if an update is needed.  A
good value here would be one hour (3600).

<retry> is how long, in seconds, a secondary name server is to retry
after a failure to check for a refresh.  A good value here would be
10 minutes (600).

<expire> is the upper limit, in seconds, that a secondary name server
is to use the data before it expires for lack of getting a refresh.
You want this to be rather large, and a nice value is 3600000, about
42 days.

<minimum> is the minimum number of seconds to be used for TTL values
in RRs.  A minimum of at least a day is a good value here (86400).

There should only be one SOA record per zone.  A sample SOA record
would look something like:

@   IN   SOA   SRI-NIC.ARPA.   HOSTMASTER.SRI-NIC.ARPA. (
    45         ;serial
    3600       ;refresh
    600        ;retry
    3600000    ;expire
    86400 )    ;minimum

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

Formats the value using the given formatter.

impl Hash for SOA

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 PartialEq for SOA

fn eq(&self, other: &SOA) -> 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 RecordData for SOA

fn try_from_rdata(data: RData) -> Result<Self, RData>

Attempts to convert to this RecordData from the RData type, if it is not the correct type the original is returned

fn try_borrow(data: &RData) -> Option<&Self>

Attempts to borrow this RecordData from the RData type, if it is not the correct type the original is returned

fn record_type(&self) -> RecordType

Get the associated RecordType for the RecordData

fn into_rdata(self) -> RData

Converts this RecordData into generic RecordData

fn is_update(&self) -> bool

RDLENGTH = 0

impl Serialize for SOA

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SOA

impl StructuralPartialEq for SOA