Struct rocket_contrib::UUID
[−]
[src]
pub struct UUID(_);
Implements FromParam
and FormFormValue
for accepting UUID values from
the uuid crate.
Usage
To use, add the uuid
feature to the rocket_contrib
dependencies section
of your Cargo.toml
:
[dependencies.rocket_contrib]
version = "*"
default-features = false
features = ["uuid"]
You can use the UUID
type directly as a target of a dynamic parameter:
#[get("/users/<id>")] fn user(id: UUID) -> String { format!("We found: {}", id) }
You can also use the UUID
as a form value, including in query strings:
#[derive(FromForm)] struct UserQuery { id: UUID } #[post("/user?<user_query>")] fn user(user_query: UserQuery) -> String { format!("User ID: {}", user_query.id) }
Methods
impl UUID
[src]
pub fn into_inner(self) -> Uuid
[src]
Consumes the UUID wrapper returning the underlying Uuid
type.
Example
let uuid_str = "c1aa1e3b-9614-4895-9ebd-705255fa5bc2"; let real_uuid = Uuid::from_str(uuid_str).unwrap(); let my_inner_uuid = UUID::from_str(uuid_str).unwrap().into_inner(); assert_eq!(real_uuid, my_inner_uuid);
Methods from Deref<Target = Uuid>
pub fn get_variant(&self) -> Option<UuidVariant>
[src]
Returns the variant of the Uuid
structure.
This determines the interpretation of the structure of the UUID. Currently only the RFC4122 variant is generated by this module.
pub fn get_version_num(&self) -> usize
[src]
Returns the version number of the Uuid
.
This represents the algorithm used to generate the contents.
Currently only the Random (V4) algorithm is supported by this module. There are security and privacy implications for using older versions - see Wikipedia: Universally Unique Identifier for details.
pub fn get_version(&self) -> Option<UuidVersion>
[src]
Returns the version of the Uuid
.
This represents the algorithm used to generate the contents
pub fn as_bytes(&self) -> &[u8; 16]
[src]
Return an array of 16 octets containing the UUID data
Examples
use uuid::Uuid; let uuid = Uuid::nil(); assert_eq!(uuid.as_bytes(), &[0; 16]); let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8").unwrap(); assert_eq!(uuid.as_bytes(), &[147, 109, 160, 31, 154, 189, 77, 157, 128, 199, 2, 175, 133, 200, 34, 168]);
pub fn simple(&self) -> Simple
[src]
Returns a wrapper which when formatted via fmt::Display
will format a
string of 32 hexadecimal digits.
Examples
use uuid::Uuid; let uuid = Uuid::nil(); assert_eq!(uuid.simple().to_string(), "00000000000000000000000000000000");
pub fn hyphenated(&self) -> Hyphenated
[src]
Returns a wrapper which when formatted via fmt::Display
will format a
string of hexadecimal digits separated into groups with a hyphen.
Examples
use uuid::Uuid; let uuid = Uuid::nil(); assert_eq!(uuid.hyphenated().to_string(), "00000000-0000-0000-0000-000000000000");
pub fn urn(&self) -> Urn
[src]
Returns a wrapper which when formatted via fmt::Display
will format a
string of the UUID as a full URN string.
Examples
use uuid::Uuid; let uuid = Uuid::nil(); assert_eq!(uuid.urn().to_string(), "urn:uuid:00000000-0000-0000-0000-000000000000");
pub fn to_timestamp(&self) -> Option<(u64, u16)>
[src]
Returns an Optional Tuple of (u64, u16) representing the timestamp and counter portion of a V1 UUID. If the supplied UUID is not V1, this will return None
pub fn is_nil(&self) -> bool
[src]
Tests if the UUID is nil
Trait Implementations
impl Copy for UUID
[src]
impl Clone for UUID
[src]
fn clone(&self) -> UUID
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for UUID
[src]
fn eq(&self, __arg_0: &UUID) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &UUID) -> bool
[src]
This method tests for !=
.
impl Eq for UUID
[src]
impl PartialOrd for UUID
[src]
fn partial_cmp(&self, __arg_0: &UUID) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &UUID) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &UUID) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &UUID) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &UUID) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for UUID
[src]
fn cmp(&self, __arg_0: &UUID) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Debug for UUID
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Display for UUID
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<'a> FromParam<'a> for UUID
[src]
type Error = UuidParseError
The associated error to be returned when parsing fails.
fn from_param(param: &'a RawStr) -> Result<UUID, Self::Error>
[src]
A value is successfully parsed if param
is a properly formatted UUID.
Otherwise, a UuidParseError
is returned.
impl<'v> FromFormValue<'v> for UUID
[src]
type Error = &'v RawStr
The associated error which can be returned from parsing. It is a good idea to have the return type be or contain an &'v str
so that the unparseable string can be examined after a bad parse. Read more
fn from_form_value(form_value: &'v RawStr) -> Result<UUID, &'v RawStr>
[src]
A value is successfully parsed if form_value
is a properly formatted
UUID. Otherwise, the raw form value is returned.
fn default() -> Option<Self>
[src]
Returns a default value to be used when the form field does not exist. If this returns None
, then the field is required. Otherwise, this should return Some(default_value)
. The default implementation simply returns None
. Read more
impl FromStr for UUID
[src]
type Err = UuidParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<UUID, Self::Err>
[src]
Parses a string s
to return a value of this type. Read more
impl Deref for UUID
[src]
type Target = Uuid
The resulting type after dereferencing.
fn deref<'a>(&'a self) -> &'a Self::Target
[src]
Dereferences the value.