Struct Urn

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

Format a Uuid as a URN string, like urn:uuid:67e55044-10b1-426f-9247-bb680e5fe0c8.

Implementations

impl Urn

pub const LENGTH: usize = 45usize

The length of a URN Uuid string.

pub const fn from_uuid(uuid: Uuid) -> Urn

Creates a Urn from a Uuid.

pub fn encode_lower<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str

Writes the Uuid as a lower-case URN string to buffer, and returns the subslice of the buffer that contains the encoded UUID.

This is slightly more efficient than using the formatting infrastructure as it avoids virtual calls, and may avoid double buffering.

Panics

Panics if the buffer is not large enough: it must have length at least LENGTH. Uuid::encode_buffer can be used to get a sufficiently-large temporary buffer.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8")?;

    // the encoded portion is returned
    assert_eq!(
        uuid.urn().encode_lower(&mut Uuid::encode_buffer()),
        "urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8"
    );

    // the buffer is mutated directly, and trailing contents remains
    let mut buf = [b'!'; 49];
    uuid.urn().encode_lower(&mut buf);
    assert_eq!(
        uuid.urn().encode_lower(&mut buf),
        "urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8"
    );
    assert_eq!(
        &buf as &[_],
        b"urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8!!!!" as &[_]
    );
     
    Ok(())
}

*/

pub fn encode_upper<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str

Writes the Uuid as an upper-case URN string to buffer, and returns the subslice of the buffer that contains the encoded UUID.

This is slightly more efficient than using the formatting infrastructure as it avoids virtual calls, and may avoid double buffering.

Panics

Panics if the buffer is not large enough: it must have length at least LENGTH. Uuid::encode_buffer can be used to get a sufficiently-large temporary buffer.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8")?;

    // the encoded portion is returned
    assert_eq!(
        uuid.urn().encode_upper(&mut Uuid::encode_buffer()),
        "urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
    );

    // the buffer is mutated directly, and trailing contents remains
    let mut buf = [b'!'; 49];
    assert_eq!(
        uuid.urn().encode_upper(&mut buf),
        "urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
    );
    assert_eq!(
        &buf as &[_],
        b"urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8!!!!" as &[_]
    );

    Ok(())
}

*/

pub const fn as_uuid(&self) -> &Uuid

Get a reference to the underlying Uuid.

Examples

use uuid::Uuid;

let urn = Uuid::nil().urn();
assert_eq!(*urn.as_uuid(), Uuid::nil());

pub const fn into_uuid(self) -> Uuid

Consumes the Urn, returning the underlying Uuid.

Examples

use uuid::Uuid;

let urn = Uuid::nil().urn();
assert_eq!(urn.into_uuid(), Uuid::nil());

Trait Implementations

impl AsRef<Uuid> for Urn

fn as_ref(&self) -> &Uuid

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Uuid> for Urn

fn borrow(&self) -> &Uuid

Immutably borrows from an owned value.

impl Clone for Urn

fn clone(&self) -> Urn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Urn

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

Formats the value using the given formatter.

impl Default for Urn

fn default() -> Urn

Returns the “default value” for a type.

impl Display for Urn

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

Formats the value using the given formatter.

impl From<Urn> for Uuid

fn from(f: Urn) -> Uuid

Converts to this type from the input type.

impl From<Uuid> for Urn

fn from(f: Uuid) -> Urn

Converts to this type from the input type.

impl FromStr for Urn

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Urn, <Urn as FromStr>::Err>

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

impl Hash for Urn

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 LowerHex for Urn

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

Formats the value using the given formatter.

impl Ord for Urn

fn cmp(&self, other: &Urn) -> 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 Urn

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

fn partial_cmp(&self, other: &Urn) -> 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 UpperHex for Urn

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

Formats the value using the given formatter.

impl Copy for Urn

impl Eq for Urn

impl StructuralPartialEq for Urn