Struct uuid::fmt::Urn

source ·
pub struct Urn(/* private fields */);
Expand description

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

Implementations§

source§

impl Urn

source

pub const LENGTH: usize = 45usize

The length of a URN Uuid string.

source

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

Creates a Urn from a Uuid.

source

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(())
}

*/

source

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(())
}

*/

source

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());
source

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§

source§

impl AsRef<Uuid> for Urn

source§

fn as_ref(&self) -> &Uuid

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

impl Borrow<Uuid> for Urn

source§

fn borrow(&self) -> &Uuid

Immutably borrows from an owned value. Read more
source§

impl Clone for Urn

source§

fn clone(&self) -> Urn

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Urn

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Urn

source§

fn default() -> Urn

Returns the “default value” for a type. Read more
source§

impl Display for Urn

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Urn> for Uuid

source§

fn from(f: Urn) -> Self

Converts to this type from the input type.
source§

impl From<Uuid> for Urn

source§

fn from(f: Uuid) -> Self

Converts to this type from the input type.
source§

impl Hash for Urn

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for Urn

source§

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

Formats the value using the given formatter. Read more
source§

impl Ord for Urn

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Urn

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Urn

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl UpperHex for Urn

source§

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

Formats the value using the given formatter. Read more
source§

impl Copy for Urn

source§

impl Eq for Urn

source§

impl StructuralPartialEq for Urn

Auto Trait Implementations§

§

impl Freeze for Urn

§

impl RefUnwindSafe for Urn

§

impl Send for Urn

§

impl Sync for Urn

§

impl Unpin for Urn

§

impl UnwindSafe for Urn

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.