Struct BitString

pub struct BitString { /* private fields */ }

Status List.

A Status List is a byte array that contains the statuses of many Referenced Tokens represented by one or multiple bits.

See: https://www.ietf.org/archive/id/draft-ietf-oauth-status-list-02.html#section-4

Implementations

impl BitString

pub const DEFAULT_LIMIT: u64 = 16_777_216u64

Default maximum bitstring size allowed by the from_compressed_bytes function.

16MB.

pub fn new(status_size: StatusSize) -> Self

Creates a new status list with the given status size.

pub fn new_with( status_size: StatusSize, len: usize, f: impl FnMut(usize) -> u8, ) -> Result<Self, Overflow>

Creates a new status list of the given length, using f to initialize every status.

The f function is called with the index of the initialized status.

pub fn new_with_value( status_size: StatusSize, len: usize, value: u8, ) -> Result<Self, Overflow>

Creates a new status list of the given length, setting every status to the same value.

pub fn new_zeroed(status_size: StatusSize, len: usize) -> Self

Creates a new status list of the given length, setting every status to 0.

This is an alias for Self::new_valid.

pub fn new_valid(status_size: StatusSize, len: usize) -> Self

Creates a new status list of the given length, setting every status to VALID.

pub fn new_invalid(status_size: StatusSize, len: usize) -> Self

Creates a new status list of the given length, setting every status to INVALID.

pub fn with_capacity(status_size: StatusSize, capacity: usize) -> Self

Creates a new status list with the given status size and capacity (in number of statuses).

pub fn from_parts(status_size: StatusSize, data: Vec<u8>) -> Self

Creates a new status list from a status size and byte array.

pub fn from_compressed_bytes( status_size: StatusSize, bytes: &[u8], limit: Option<u64>, ) -> Result<Self, Error>

Decompress a bit-string using DEFLATE (RFC1951) with the ZLIB (RFC1950) data format.

pub fn status_size(&self) -> StatusSize

Returns the status bit-size.

pub fn is_empty(&self) -> bool

Checks if the list is empty.

pub fn len(&self) -> usize

Returns the length of the list (number of statuses).

pub fn get(&self, index: usize) -> Option<u8>

Returns index-th status in the list.

pub fn set(&mut self, index: usize, value: u8) -> Result<u8, Overflow>

Sets the value at the given index.

Returns the previous value, or an Overflow error if either the index is out of bounds or the value is too large.

pub fn push(&mut self, value: u8) -> Result<usize, Overflow>

Push a new value into the bit-string.

Returns the index of the newly inserted value in the list, or an error if the value is too large w.r.t. status_size.

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

Returns this bit-string as a byte slice.

pub fn to_compressed_bytes(&self, compression: Compression) -> Vec<u8>

Compress the bit-string using DEFLATE (RFC1951) with the ZLIB (RFC1950) data format.

pub fn iter(&self) -> BitStringIter<'_>

Returns an iterator over all the statuses stored in this bit-string.

pub fn into_parts(self) -> (StatusSize, Vec<u8>)

Consumes the bit-string and returns the status size and underlying byte array.

Trait Implementations

impl Clone for BitString

fn clone(&self) -> BitString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitString

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

Formats the value using the given formatter.

impl Hash for BitString

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 BitString

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

impl PartialEq for BitString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BitString

fn partial_cmp(&self, other: &BitString) -> 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 Eq for BitString

impl StructuralPartialEq for BitString