Struct sequoia_openpgp::types::Bitfield

source ·
pub struct Bitfield { /* private fields */ }
Expand description

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§

source§

impl Bitfield

source

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);
source

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());
source

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));
source

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]);
source

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);
source

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);
source

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());
source

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);
source

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§

source§

impl AsMut<[u8]> for Bitfield

source§

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

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

impl AsRef<[u8]> for Bitfield

source§

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

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

impl Clone for Bitfield

source§

fn clone(&self) -> Bitfield

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Bitfield

source§

fn default() -> Bitfield

Returns the “default value” for a type. Read more
source§

impl From<Vec<u8>> for Bitfield

source§

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

Converts to this type from the input type.
source§

impl Hash for Bitfield

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Bitfield

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Bitfield

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Bitfield

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Eq for Bitfield

source§

impl StructuralPartialEq for Bitfield

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T