Struct uuid::adapter::Urn

pub struct Urn(_);

An adaptor for formatting an Uuid as a URN string.

Takes an owned instance of the Uuid.

Implementations

impl Urn

pub const LENGTH: usize

The length of a URN Uuid string.

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

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;

let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8").unwrap();

// the encoded portion is returned
assert_eq!(
    uuid.to_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.to_urn().encode_lower(&mut buf);
assert_eq!(
    uuid.to_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 &[_]
);

*/

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;

let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8").unwrap();

// the encoded portion is returned
assert_eq!(
    uuid.to_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.to_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 &[_]
);

*/

Trait Implementations

impl Clone for Urn

fn clone(&self) -> Urn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Urn

impl Debug for Urn

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

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

Formats the value using the given formatter.

impl Eq for Urn

impl From<Uuid> for Urn

fn from(f: Uuid) -> Self

Performs the conversion.

impl Hash for Urn

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Urn

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

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.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Urn> for Urn

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Urn> for Urn

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Urn

impl StructuralPartialEq for Urn

impl UpperHex for Urn

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

Formats the value using the given formatter.