Struct sequoia_openpgp::types::Bitfield

pub struct Bitfield { /* private fields */ }

A variable-sized set of boolean flags.

This encodes flags in signature subpackets such as Features and KeyFlags. The Bitfield grows to accommodate all bits that are set, and querying a bit outside the allocated space will return false. Note that it will not automatically shrink if clearing a bit would leave trailing bytes to be zero. To do that, explicitly call Bitfield::canonicalize.

Implementations

impl Bitfield

pub fn iter_set(&self) -> impl Iterator<Item = usize> + Send + Sync + '_

Returns all bits that are set starting from bit 0, the least-significant bit in the left-most byte.

Examples

let f = Bitfield::from(vec![0b0000_0001, 0b0000_0010]);
let mut i = f.iter_set();
assert_eq!(i.next(), Some(0));
assert_eq!(i.next(), Some(9));
assert_eq!(i.next(), None);

pub fn padding_bytes(&self) -> Option<NonZeroUsize>

Returns the number of trailing zero bytes.

Examples

let mut f = Bitfield::from(vec![0b0000_0001]);
assert!(f.padding_bytes().is_none());
f.clear(0);
assert_eq!(f.padding_bytes().unwrap().get(), 1);
f.canonicalize();
assert!(f.padding_bytes().is_none());

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

Compares two feature sets for semantic equality.

Returns true if both sets have the same flags set, i.e. this function ignores any trailing zero bytes.

Examples

let f = Bitfield::from(vec![0b0000_0001]);
let g = Bitfield::from(vec![0b0000_0001, 0b0000_0000]);
assert!(f != g);
assert!(f.normalized_eq(&g));

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

Returns a slice containing the raw values.

Examples

let mut f = Bitfield::default();
assert_eq!(f.as_bytes(), &[]);
f.set(0);
assert_eq!(f.as_bytes(), &[0b0000_0001]);

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Returns a mutable slice containing the raw values.

Examples

let mut f = Bitfield::from(vec![0b0000_0000]);
assert_eq!(f.get(0), false);
f.as_bytes_mut()[0] = 0b0000_0001;
assert_eq!(f.get(0), true);

pub fn get(&self, bit: usize) -> bool

Returns whether the specified flag is set.

Examples

let f = Bitfield::default();
assert_eq!(f.get(0), false);
assert_eq!(f.get(23), false);

let f = Bitfield::from(vec![0b0000_0001]);
assert_eq!(f.get(0), true);

pub fn canonicalize(&mut self)

Canonicalize by removing any trailing zero bytes.

Examples

let mut f = Bitfield::from(vec![0b0000_0001]);
assert!(f.padding_bytes().is_none());
f.clear(0);
assert_eq!(f.padding_bytes().unwrap().get(), 1);
f.canonicalize();
assert!(f.padding_bytes().is_none());

pub fn set(&mut self, bit: usize)

Sets the specified flag.

Examples

let mut f = Bitfield::default();
assert_eq!(f.get(0), false);
f.set(0);
assert_eq!(f.get(0), true);

pub fn clear(&mut self, bit: usize)

Clears the specified flag.

Note: This does not implicitly canonicalize the bit field. To do that, invoke Bitfield::canonicalize.

Examples

let mut f = Bitfield::from(vec![0b0000_0001]);
assert_eq!(f.get(0), true);
f.clear(0);
assert_eq!(f.get(0), false);
assert_eq!(f.padding_bytes().unwrap().get(), 1);

Trait Implementations

impl AsMut<[u8]> for Bitfield

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Bitfield

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Bitfield

fn clone(&self) -> Bitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Bitfield

fn default() -> Bitfield

Returns the “default value” for a type.

impl From<Vec<u8, Global>> for Bitfield

fn from(raw: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for Bitfield

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Bitfield

fn cmp(&self, other: &Bitfield) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Bitfield> for Bitfield

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Bitfield> for Bitfield

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Bitfield

impl StructuralEq for Bitfield

impl StructuralPartialEq for Bitfield