Struct domain::base::serial::Serial

pub struct Serial(pub u32);

A serial number.

Serial numbers are used in DNS to track changes to resources. For instance, the Soa record type provides a serial number that expresses the version of the zone. Since these numbers are only 32 bits long, they can wrap. RFC 1982 defined the semantics for doing arithmetics in the face of these wrap-arounds. This type implements these semantics atop a native u32.

The RFC defines two operations: addition and comparison.

For addition, the amount added can only be a positive number of up to 2^31 - 1. Because of this, we decided to not implement the Add trait but rather have a dedicated method add so as to not cause surprise panics.

Serial numbers only implement a partial ordering. That is, there are pairs of values that are not equal but there still isn’t one value larger than the other. Since this is neatly implemented by the PartialOrd trait, the type implements that.

Tuple Fields

0: u32

Implementations

impl Serial

pub fn now() -> Self

Returns a serial number for the current Unix time.

pub fn from_be_bytes(bytes: [u8; 4]) -> Self

Creates a new serial number from its octets in big endian notation.

pub fn into_int(self) -> u32

Returns the serial number as a raw integer.

pub fn add(self, other: u32) -> Self

Add other to self.

Serial numbers only allow values of up to 2^31 - 1 to be added to them. Therefore, this method requires other to be a u32 instead of a Serial to indicate that you cannot simply add two serials together. This is also why we don’t implement the Add trait.

Panics

This method panics if other is greater than 2^31 - 1.

pub fn scan<S: Scanner>(scanner: &mut S) -> Result<Self, S::Error>

pub fn scan_rrsig<S: Scanner>(scanner: &mut S) -> Result<Self, S::Error>

Scan a serial represention signature time value.

In RRSIG records, the expiration and inception times are given as serial values. Their representation format can either be the value or a specific date in YYYYMMDDHHmmSS format.

pub fn rrsig_from_str(src: &str) -> Result<Self, IllegalSignatureTime>

Parses a serial representing a time value from a string.

In RRSIG records, the expiration and inception times are given as serial values. Their representation format can either be the value or a specific date in YYYYMMDDHHmmSS format.

impl Serial

Parsing and Composing

pub const COMPOSE_LEN: u16 = 4u16

pub fn parse<Octs: AsRef<[u8]> + ?Sized>( parser: &mut Parser<'_, Octs>, ) -> Result<Self, ParseError>

pub fn compose<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Trait Implementations

impl CanonicalOrd for Serial

fn canonical_cmp(&self, other: &Self) -> Ordering

Returns the canonical ordering between self and other.

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

Returns whether self is canonically less than other.

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

Returns whether self is canonically less than or equal to other.

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

Returns whether self is canonically greater than other.

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

Returns whether self is canonically greater than or equal to other.

impl Clone for Serial

fn clone(&self) -> Serial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Serial

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

Formats the value using the given formatter.

impl Display for Serial

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

Formats the value using the given formatter.

impl From<Serial> for u32

fn from(serial: Serial) -> u32

Converts to this type from the input type.

impl From<u32> for Serial

fn from(value: u32) -> Serial

Converts to this type from the input type.

impl FromStr for Serial

type Err = <u32 as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Serial

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 Serial

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

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

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

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

impl PartialOrd for Serial

fn partial_cmp(&self, other: &Serial) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Serial

impl Eq for Serial

impl StructuralPartialEq for Serial