Struct uuid::adapter::UrnRef

[+] Show declaration

pub struct UrnRef<'a>(_);

[−] Expand description

An adaptor for formatting an Uuid as a URN string.

Takes a reference of the Uuid.

Implementations

impl<'a> UrnRef<'a>[−]

pub const LENGTH: usize[−][−]

The length of a URN Uuid string.

pub const fn from_uuid_ref(uuid: &'a Uuid) -> Self[−]

Creates a UrnRef from a Uuid reference.

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<'a> Clone for UrnRef<'a>[+]

[+] Show hidden undocumented items

fn clone(&self) -> UrnRef<'a>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for UrnRef<'a>

impl<'a> Debug for UrnRef<'a>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'a> Display for UrnRef<'a>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'a> Eq for UrnRef<'a>

impl<'a> From<&'a Uuid> for UrnRef<'a>[+]

[+] Show hidden undocumented items

fn from(f: &'a Uuid) -> Self[−]

Performs the conversion.

impl<'a> Hash for UrnRef<'a>[+]

[+] Show hidden undocumented items

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<'a> LowerHex for UrnRef<'a>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'a> Ord for UrnRef<'a>[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &UrnRef<'a>) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

Restrict a value to a certain interval.

impl<'a> PartialEq<UrnRef<'a>> for UrnRef<'a>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &UrnRef<'a>) -> bool[−]

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

fn ne(&self, other: &UrnRef<'a>) -> bool[−]

This method tests for !=.

impl<'a> PartialOrd<UrnRef<'a>> for UrnRef<'a>[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &UrnRef<'a>) -> Option<Ordering>[−]

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

[+] Expand attributes

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

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

[+] Expand attributes

#[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.

[+] Expand attributes

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

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

[+] Expand attributes

#[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<'a> StructuralEq for UrnRef<'a>

impl<'a> StructuralPartialEq for UrnRef<'a>

impl<'a> UpperHex for UrnRef<'a>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.