Struct uuid::fmt::Braced

#[repr(transparent)]
pub struct Braced(Uuid);

Format a Uuid as a braced hyphenated string, like {67e55044-10b1-426f-9247-bb680e5fe0c8}.

Tuple Fields

0: Uuid

Implementations

impl Braced

pub const LENGTH: usize = 38usize

The length of a braced Uuid string.

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

Creates a Braced from a Uuid.

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

Writes the Uuid as a lower-case hyphenated string surrounded by braces 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.braced()
            .encode_lower(&mut Uuid::encode_buffer()),
        "{936da01f-9abd-4d9d-80c7-02af85c822a8}"
    );

    // the buffer is mutated directly, and trailing contents remains
    let mut buf = [b'!'; 40];
    uuid.braced().encode_lower(&mut buf);
    assert_eq!(
        &buf as &[_],
        b"{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 hyphenated string surrounded by braces 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.braced()
            .encode_upper(&mut Uuid::encode_buffer()),
        "{936DA01F-9ABD-4D9D-80C7-02AF85C822A8}"
    );

    // the buffer is mutated directly, and trailing contents remains
    let mut buf = [b'!'; 40];
    uuid.braced().encode_upper(&mut buf);
    assert_eq!(
        &buf as &[_],
        b"{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 braced = Uuid::nil().braced();
assert_eq!(*braced.as_uuid(), Uuid::nil());

pub const fn into_uuid(self) -> Uuid

Consumes the Braced, returning the underlying Uuid.

Examples

use uuid::Uuid;

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

Trait Implementations

impl AsRef<Uuid> for Braced

fn as_ref(&self) -> &Uuid

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

impl Borrow<Uuid> for Braced

fn borrow(&self) -> &Uuid

Immutably borrows from an owned value.

impl Clone for Braced

fn clone(&self) -> Braced

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Braced

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

Formats the value using the given formatter.

impl Default for Braced

fn default() -> Braced

Returns the “default value” for a type.

impl Display for Braced

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

Formats the value using the given formatter.

impl From<Braced> for Uuid

fn from(f: Braced) -> Self

Converts to this type from the input type.

impl From<Uuid> for Braced

fn from(f: Uuid) -> Self

Converts to this type from the input type.

impl Hash for Braced

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for Braced

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

Formats the value using the given formatter.

impl Ord for Braced

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

Restrict a value to a certain interval.

impl PartialEq for Braced

fn eq(&self, other: &Braced) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Braced

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

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

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

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

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

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

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

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

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 Serialize for Braced

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl UpperHex for Braced

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

Formats the value using the given formatter.

impl Copy for Braced

impl Eq for Braced

impl StructuralPartialEq for Braced