Struct StatusList 

pub struct StatusList { /* private fields */ }

Available on crate feature sd-jwt only.

A status list (Token Status List §4): one status of bits bits per referenced token, packed into a byte array from the least significant bit up, ZLIB-compressed and base64url-encoded as lst in JSON.

Examples

use identity_kit::sd_jwt_vc::{StatusList, StatusType};
use serde_json::json;

// Token Status List §4.1: 16 statuses of 1 bit.
let list: StatusList = serde_json::from_value(json!({ "bits": 1, "lst": "eNrbuRgAAhcBXQ" }))?;
assert_eq!(list.as_bytes(), &[0xb9, 0xa3]);
assert_eq!(list.get(0), Some(StatusType::INVALID));
assert_eq!(list.get(1), Some(StatusType::VALID));
assert_eq!(list.get(15), Some(StatusType::INVALID));
assert_eq!(list.get(16), None);

let mut rebuilt = StatusList::new(1, 16)?;
for index in [0, 3, 4, 5, 7, 8, 9, 13, 15] {
    rebuilt.set(index, StatusType::INVALID)?;
}
assert_eq!(rebuilt.as_bytes(), list.as_bytes());

Implementations

impl StatusList

pub const MAX_BYTES: usize

The largest decompressed list Deserialize accepts: 16 MiB, room for 16 million 8-bit statuses.

pub fn new(bits: u8, size: usize) -> Result<Self, StatusListError>

An all-VALID list of size statuses of bits bits each.

Errors

StatusListError::InvalidBits unless bits is 1, 2, 4 or 8.

pub fn from_bytes(bits: u8, bytes: Vec<u8>) -> Result<Self, StatusListError>

A list over the uncompressed byte array bytes.

Errors

StatusListError::InvalidBits unless bits is 1, 2, 4 or 8.

pub fn with_aggregation_uri(self, uri: impl Into<String>) -> Self

This list with aggregation_uri.

pub const fn bits(&self) -> u8

The bits per status: 1, 2, 4 or 8.

pub fn as_bytes(&self) -> &[u8]

The uncompressed byte array.

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

The aggregation_uri, if any.

pub fn len(&self) -> usize

The number of statuses the list holds.

pub fn is_empty(&self) -> bool

Whether the list holds no status.

pub fn get(&self, index: u64) -> Option<StatusType>

The status at index, or None beyond the end of the list.

pub fn set( &mut self, index: u64, status: StatusType, ) -> Result<(), StatusListError>

Sets the status at index.

Errors

StatusListError::IndexOutOfRange or StatusListError::InvalidStatusValue when the value does not fit in bits.

pub fn to_lst(&self) -> String

The ZLIB-compressed byte array, base64url-encoded: the lst member.

pub fn from_lst( bits: u8, lst: &str, max_bytes: usize, ) -> Result<Self, StatusListError>

Decodes lst, refusing a list that decompresses to more than max_bytes.

Errors

StatusListError::InvalidBits, StatusListError::Compression or StatusListError::TooLarge.

Trait Implementations

impl Clone for StatusList

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatusList

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

Decodes lst with StatusList::MAX_BYTES as the limit.

impl Eq for StatusList

impl PartialEq for StatusList

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StatusList

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StatusList