Struct StatusType 

pub struct StatusType(pub u8);

Available on crate feature sd-jwt only.

A status type value (Token Status List §7): a number in 0..=255, with the registered meanings as constants.

It serializes as its registered name when it has one of its own ("VALID", "INVALID", "SUSPENDED") and as a number otherwise. APPLICATION_SPECIFIC names 0x03 and 0x0C-0x0F alike, so those serialize as numbers too. It deserializes from a registered name, a number in 0..=255, or that number as a decimal string; parse and FromStr accept the same strings. Names are case-sensitive. Since the form depends on the value, deserializing needs a self-describing format such as JSON or CBOR.

Examples

use identity_kit::sd_jwt_vc::StatusType;
use serde_json::json;

assert_eq!(serde_json::to_value(StatusType::SUSPENDED)?, json!("SUSPENDED"));
assert_eq!(serde_json::to_value(StatusType(3))?, json!(3));
assert_eq!(serde_json::from_value::<StatusType>(json!("INVALID"))?, StatusType::INVALID);
assert_eq!(serde_json::from_value::<StatusType>(json!(12))?, StatusType(0x0C));
assert_eq!("VALID".parse::<StatusType>()?, StatusType::VALID);
assert!("APPLICATION_SPECIFIC".parse::<StatusType>().is_err());

Tuple Fields

0: u8

Implementations

impl StatusType

pub const VALID: Self

0x00: the referenced token is valid.

pub const INVALID: Self

0x01: the referenced token is revoked.

pub const SUSPENDED: Self

0x02: the referenced token is suspended.

pub const fn value(self) -> u8

The value.

pub const fn is_valid(self) -> bool

Whether this is VALID.

pub const fn name(self) -> Option<&'static str>

The registered name of the value, if it has one.

pub fn parse(s: &str) -> Result<Self, StatusListError>

The value named s: VALID, INVALID, SUSPENDED, or a decimal number in 0..=255.

Errors

StatusListError::UnknownStatusType for anything else, APPLICATION_SPECIFIC included: it names several values.

Trait Implementations

impl Clone for StatusType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StatusType

impl Debug for StatusType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatusType

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for StatusType

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

Formats the value using the given formatter.

impl Eq for StatusType

impl From<u8> for StatusType

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromStr for StatusType

type Err = StatusListError

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 StatusType

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 StatusType

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StatusType

fn partial_cmp(&self, other: &Self) -> 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 PartialSchema for StatusType

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for StatusType

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StatusType

impl ToSchema for StatusType

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.