Struct urn::Urn

pub struct Urn { /* fields omitted */ }

An RFC2141/8141 URN (Uniform Resource Name).

Note: the equivalence checks are done according to the specification, only taking the NID and NSS into account! If you need exact equivalence checks, consider comparing using Urn::as_str() as the key. Some namespaces may define additional lexical equivalence checks, these aren’t accounted for in this implementation.

Implementations

impl Urn

pub fn as_str(&self) -> &str

String representation of the current URN (Canonicized).

pub fn nid(&self) -> &str

NID (Namespace identifier), the first part of the URN.

For example, in urn:ietf:rfc:2648, ietf is the namespace.

pub fn set_nid(&mut self, nid: &str) -> Result<(), Error>

Set the NID (must be a valid NID).

pub fn nss(&self) -> &str

NSS (Namespace-specific string) identifying the resource.

For example, in urn:ietf:rfc:2648, rfs:2648 is the NSS.

pub fn set_nss(&mut self, nss: &str) -> Result<(), Error>

Set the namespace-specific string (must be a valid NSS and use percent-encoding).

pub fn r_component(&self) -> Option<&str>

r-component, following the ?+ character sequence, to be used for passing parameters to URN resolution services.

In urn:example:foo-bar-baz-qux?+CCResolve:cc=uk, CCResolve:cc=uk is the r-component.

Should not be used for equivalence checks. As of 2021, exact semantics are undefined.

pub fn set_r_component(
    &mut self,
    r_component: Option<&str>
) -> Result<(), Error>

Set the r-component (must be a valid r-component and use percent-encoding).

pub fn q_component(&self) -> Option<&str>

q-component, following the ?= character sequence. Has a similar function to the URL query string.

Should not be used for equivalence checks.

pub fn set_q_component(
    &mut self,
    q_component: Option<&str>
) -> Result<(), Error>

Set the q-component (must be a valid q-component and use percent-encoding).

pub fn f_component(&self) -> Option<&str>

f-component (fragment) following the # character at the end of the URN.

Should not be used for equivalence checks.

pub fn set_f_component(
    &mut self,
    f_component: Option<&str>
) -> Result<(), Error>

Set the f-component (must be a valid f-component and use percent-encoding).

Trait Implementations

impl AsRef<[u8]> for Urn

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<str> for Urn

fn as_ref(&self) -> &str

Performs the conversion.

impl Debug for Urn

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

Formats the value using the given formatter.

impl Deref for Urn

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Urn

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

Formats the value using the given formatter.

impl FromStr for Urn

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Urn

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Urn> for Urn

fn eq(&self, other: &Self) -> 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 !=.

impl TryFrom<&'_ str> for Urn

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<String> for Urn

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Error>

Performs the conversion.

impl Eq for Urn