Struct Subname 

pub struct Subname(/* private fields */);

The label part of an RRset name, relative to the zone.

The API spells the zone apex two different ways: "" in a JSON payload, and @ in a URL path. They are not interchangeable — an empty path segment collapses under HTTP path normalization, so /rrsets//A/ does not reach the apex — and since the API returns "", code that round-trips an RRset has to translate rather than substitute. That translation is this type’s whole reason for existing: as_payload for bodies, as_path for URLs.

use desec::Subname;

let apex = Subname::apex();
assert_eq!(apex.as_payload(), "");
assert_eq!(apex.as_path(), "@");

let www: Subname = "www".parse()?;
assert_eq!(www.as_payload(), "www");
assert_eq!(www.as_path(), "www");

Implementations

impl Subname

pub const MAX_LEN: usize = 178

Longest subname the API accepts.

pub const fn apex() -> Self

The zone apex.

pub fn new(subname: impl Into<String>) -> Result<Self, InvalidValue>

Validates and wraps a subname.

Accepts "" and "@" as the apex, so a value read from either a payload or a path can be passed straight in.

pub fn as_payload(&self) -> &str

The spelling to put in a JSON body: "" at the apex.

pub fn as_path(&self) -> &str

The spelling to put in a URL path segment: @ at the apex.

pub fn is_apex(&self) -> bool

Whether this is the zone apex.

Trait Implementations

impl Clone for Subname

fn clone(&self) -> Subname

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subname

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

Formats the value using the given formatter.

impl Default for Subname

fn default() -> Subname

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Subname

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Subname

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

Renders the payload spelling, so the apex formats as the empty string.

impl Eq for Subname

impl FromStr for Subname

type Err = InvalidValue

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 Subname

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 Ord for Subname

fn cmp(&self, other: &Subname) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Subname

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Subname

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Subname

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Subname