Implements FromParam
and FormFormValue
for accepting UUID values from
the uuid crate.
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)
}
Consumes the UUID wrapper returning the underlying Uuid
type.
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);
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.
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.
Returns the version of the Uuid
.
This represents the algorithm used to generate the contents
Returns the four field values of the UUID.
These values can be passed to the from_fields()
method to get the
original Uuid
back.
- The first field value represents the first group of (eight) hex
digits, taken as a big-endian
u32
value. For V1 UUIDs, this field
represents the low 32 bits of the timestamp.
- The second field value represents the second group of (four) hex
digits, taken as a big-endian
u16
value. For V1 UUIDs, this field
represents the middle 16 bits of the timestamp.
- The third field value represents the third group of (four) hex
digits, taken as a big-endian
u16
value. The 4 most significant
bits give the UUID version, and for V1 UUIDs, the last 12 bits
represent the high 12 bits of the timestamp.
- The last field value represents the last two groups of four and
twelve hex digits, taken in order. The first 1-3 bits of this
indicate the UUID variant, and for V1 UUIDs, the next 13-15 bits
indicate the clock sequence and the last 48 bits indicate the node
ID.
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));
let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8").unwrap();
assert_eq!(uuid.as_fields(),
(0x936DA01F, 0x9ABD, 0x4D9D, b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"));
Returns an array of 16 octets containing the UUID data.
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]);
Returns a wrapper which when formatted via fmt::Display
will format a
string of 32 hexadecimal digits.
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(uuid.simple().to_string(),
"00000000000000000000000000000000");
Returns a wrapper which when formatted via fmt::Display
will format a
string of hexadecimal digits separated into groups with a hyphen.
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(uuid.hyphenated().to_string(),
"00000000-0000-0000-0000-000000000000");
Returns a wrapper which when formatted via fmt::Display
will format a
string of the UUID as a full URN string.
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(uuid.urn().to_string(),
"urn:uuid:00000000-0000-0000-0000-000000000000");
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
Performs copy-assignment from source
. Read more
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
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
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
The associated error to be returned when parsing fails.
A value is successfully parsed if param
is a properly formatted UUID.
Otherwise, a UuidParseError
is returned.
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
A value is successfully parsed if form_value
is a properly formatted
UUID. Otherwise, the raw form value is returned.
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
The associated error which can be returned from parsing.
Parses a string s
to return a value of this type. Read more
The resulting type after dereferencing.
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.