Struct uuid::adapter::Hyphenated

pub struct Hyphenated(_);

An adaptor for formatting an Uuid as a hyphenated string.

Takes an owned instance of the Uuid.

Methods

impl Hyphenated

pub const LENGTH: usize

The length of a hyphenated Uuid string.

pub fn from_uuid(uuid: Uuid) -> Self

Creates a Hyphenated 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 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_hyphenated()
        .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.to_hyphenated().encode_lower(&mut buf);
assert_eq!(
    &buf as &[_],
    b"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 hyphenated 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_hyphenated()
        .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.to_hyphenated().encode_upper(&mut buf);
assert_eq!(
    &buf as &[_],
    b"936DA01F-9ABD-4D9D-80C7-02AF85C822A8!!!!" as &[_]
);

*/

Trait Implementations

impl PartialOrd<Hyphenated> for Hyphenated

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

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

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

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

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

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

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

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

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

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

impl Copy for Hyphenated

impl PartialEq<Hyphenated> for Hyphenated

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

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

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

This method tests for !=.

impl Default for Hyphenated

fn default() -> Hyphenated

Returns the "default value" for a type.

impl From<Uuid> for Hyphenated

fn from(f: Uuid) -> Self

Performs the conversion.

impl Clone for Hyphenated

fn clone(&self) -> Hyphenated

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Hyphenated

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Hyphenated

impl Display for Hyphenated

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

Formats the value using the given formatter.

impl Debug for Hyphenated

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

Formats the value using the given formatter.

impl Hash for Hyphenated

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Hyphenated

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

Formats the value using the given formatter.

impl UpperHex for Hyphenated

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

Formats the value using the given formatter.