Enum TaskId 

#[non_exhaustive]
pub enum TaskId {
    Int(u64),
    String(String),
    Uuid(Uuid),
    Ulid(Ulid),
}

A wrapper type that defines a task id.

Supports a fixed set of common identifier representations. Uuid and Ulid variants are only available when the corresponding crate features are enabled.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Int(u64)

An integer-based id

String(String)

A string-based id

Uuid(Uuid)

Available on crate feature uuid only.

A UUID-based id

Ulid(Ulid)

Available on crate feature ulid only.

A ULID-based id

Implementations

impl TaskId

pub fn from_int(id: u64) -> Self

Construct a TaskId from an integer.

pub fn from_string(id: impl Into<String>) -> Self

Construct a TaskId from a string.

pub fn from_uuid(id: Uuid) -> Self

Available on crate feature uuid only.

Construct a TaskId from a UUID.

pub fn from_ulid(id: Ulid) -> Self

Available on crate feature ulid only.

Construct a TaskId from a ULID.

pub fn as_int(&self) -> Option<u64>

Returns the inner value as an integer, if this is an Int variant.

pub fn as_string(&self) -> Option<&str>

Returns the inner value as a string slice, if this is a String variant.

pub fn as_uuid(&self) -> Option<Uuid>

Available on crate feature uuid only.

Returns the inner value as a Uuid, if this is a Uuid variant.

pub fn as_ulid(&self) -> Option<Ulid>

Available on crate feature ulid only.

Returns the inner value as a Ulid, if this is a Ulid variant.

impl TaskId

pub fn to_uuid(&self) -> Uuid

Available on crate feature uuid only.

Generates a deterministic uuid based on the task id.

Trait Implementations

impl Clone for TaskId

fn clone(&self) -> TaskId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskId

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TaskId

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

Formats the value using the given formatter.

impl Eq for TaskId

impl From<String> for TaskId

fn from(id: String) -> Self

Converts to this type from the input type.

impl From<Ulid> for TaskId

Available on crate feature ulid only.

fn from(id: Ulid) -> Self

Converts to this type from the input type.

impl From<Uuid> for TaskId

Available on crate feature uuid only.

fn from(id: Uuid) -> Self

Converts to this type from the input type.

impl From<u64> for TaskId

fn from(id: u64) -> Self

Converts to this type from the input type.

impl<Args: Sync> FromRequest<Task<Args>> for TaskId

type Error = MissingDataError

The error type that can occur during extraction.

async fn from_request(req: &Task<Args>) -> Result<Self, Self::Error>

Perform the extraction.

impl FromStr for TaskId

type Err = TaskIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TaskId

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 Ord for TaskId

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

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for TaskId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TaskId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TaskId

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TaskId

impl TryFrom<&str> for TaskId

type Error = TaskIdError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.