Enum domain::base::name::UncertainName

source ·

pub enum UncertainName<Octets> {
    Absolute(Name<Octets>),
    Relative(RelativeName<Octets>),
}

Expand description

A domain name that may be absolute or relative.

This type is helpful when reading a domain name from some source where it may end up being absolute or not.

Variants§

§

Absolute(Name<Octets>)

§

Relative(RelativeName<Octets>)

Implementations§

source §

impl<Octets> UncertainName<Octets>

source

pub fn absolute(name: Name<Octets>) -> Self

Creates a new uncertain domain name from an absolute domain name.

source

pub fn relative(name: RelativeName<Octets>) -> Self

Creates a new uncertain domain name from a relative domain name.

source

pub fn root() -> Self
where Octets: From<&'static [u8]>,

Creates a new uncertain domain name containing the root label only.

source

pub fn empty() -> Self
where Octets: From<&'static [u8]>,

Creates a new uncertain yet empty domain name.

source

pub fn from_octets(octets: Octets) -> Result<Self, UncertainDnameError>
where Octets: AsRef<[u8]>,

Creates a new domain name from its wire format representation.

The returned name will correctly be identified as an absolute or relative name.

source

pub fn from_chars<C>(chars: C) -> Result<Self, FromStrError>
where Octets: FromBuilder, <Octets as FromBuilder>::Builder: FreezeBuilder<Octets = Octets> + EmptyBuilder + AsRef<[u8]> + AsMut<[u8]>, C: IntoIterator<Item = char>,

Creates a domain name from a sequence of characters.

The sequence must result in a domain name in zone file representation. That is, its labels should be separated by dots, while actual dots, white space and backslashes should be escaped by a preceeding backslash, and any byte value that is not a printable ASCII character should be encoded by a backslash followed by its three digit decimal value.

If Internationalized Domain Names are to be used, the labels already need to be in punycode-encoded form.

If the last character is a dot, the name will be absolute, otherwise it will be relative.

If you have a string, you can also use the FromStr trait, which really does the same thing.

source

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

source §

impl UncertainName<&'static [u8]>

source

pub fn empty_ref() -> Self

Creates an empty relative name atop a slice reference.

source

pub fn root_ref() -> Self

Creates an absolute name that is the root label atop a slice reference.

source §

impl UncertainName<Vec<u8>>

source

pub fn empty_vec() -> Self

Creates an empty relative name atop a Vec<u8>.

source

pub fn root_vec() -> Self

Creates an absolute name from the root label atop a Vec<u8>.

source §

impl UncertainName<Bytes>

source

pub fn empty_bytes() -> Self

Creates an empty relative name atop a bytes value.

source

pub fn root_bytes() -> Self

Creates an absolute name from the root label atop a bytes value.

source §

impl<Octets> UncertainName<Octets>

source

pub fn is_absolute(&self) -> bool

Returns whether the name is absolute.

source

pub fn is_relative(&self) -> bool

Returns whether the name is relative.

source

pub fn as_absolute(&self) -> Option<&Name<Octets>>

Returns a reference to an absolute name, if this name is absolute.

source

pub fn as_relative(&self) -> Option<&RelativeName<Octets>>

Returns a reference to a relative name, if the name is relative.

source

pub fn into_absolute(self) -> Result<Name<Octets>, PushError>
where Octets: AsRef<[u8]> + IntoBuilder, <Octets as IntoBuilder>::Builder: FreezeBuilder<Octets = Octets> + AsRef<[u8]> + AsMut<[u8]>,

Converts the name into an absolute name.

If the name is relative, appends the root label to it using RelativeName::into_absolute.

source

pub fn try_into_absolute(self) -> Result<Name<Octets>, Self>

Converts the name into an absolute name if it is absolute.

Otherwise, returns itself as the error.

source

pub fn try_into_relative(self) -> Result<RelativeName<Octets>, Self>

Converts the name into a relative name if it is relative.

Otherwise just returns itself as the error.

source

pub fn as_octets(&self) -> &Octets

Returns a reference to the underlying octets sequence.

source

pub fn as_slice(&self) -> &[u8] ⓘ
where Octets: AsRef<[u8]>,

Returns an octets slice with the raw content of the name.

source

pub fn chain<S: ToLabelIter>( self, suffix: S, ) -> Result<Chain<Self, S>, LongChainError>
where Octets: AsRef<[u8]>,

Makes an uncertain name absolute by chaining on a suffix if needed.

The method converts the uncertain name into a chain that will be absolute. If the name is already absolute, the chain will be the name itself. If it is relative, if will be the concatenation of the name and suffix.