Struct BitString 

pub struct BitString<'a>(/* private fields */);

A BIT STRING of any length: its octets, the last one padded with zero bits, and how many bits it has.

The octets are borrowed from what was decoded, or owned, as those of Octets. A string of 64 bits at most is held in the value itself, and never allocates.

use oxirush_aper::BitString;

// A key of 256 bits: every bit of its octets
let key = BitString::from([0x5a; 32]);
assert_eq!(key.len(), 256);
assert_eq!(key.as_octets().len(), 32);

// A transport layer address of 20 bits has three octets
let bits = BitString::new(vec![0xab, 0xcd, 0xe0], 20)?;
assert_eq!(bits.get(0), Some(true));
assert_eq!(bits.get(20), None);

// The bits after the last one are zero
assert!(BitString::new(vec![0xab, 0xcd, 0xef], 20).is_err());

Implementations

impl<'a> BitString<'a>

pub const EMPTY: Self

No bit.

pub fn new(octets: impl Into<Octets<'a>>, length: usize) -> Result<Self, Error>

The bit string of length bits that octets hold from their first bit.

Errors

An error of the kind Argument for other octets than length bits take, and for bits after the last one that are not zero.

pub fn from_octets(octets: impl Into<Octets<'a>>) -> Self

The bit string that is every bit of octets.

pub fn len(&self) -> usize

How many bits the string has.

pub fn is_empty(&self) -> bool

Whether the string has no bit.

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

The octets of the string, the last one padded with zero bits.

pub fn get(&self, position: usize) -> Option<bool>

The bit at a position, the first one at 0; None after the last.

pub fn to_bits(&self) -> Option<Bits>

The string as a number, when it has 64 bits at most.

pub fn into_owned(self) -> BitString<'static>

The same string, with octets that it owns, kept as long as it is needed: BitString<'static> is the type to write in a struct. The octets are copied when they were borrowed.

Trait Implementations

impl<'a> Clone for BitString<'a>

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 BitString<'_>

The octets in hexadecimal, and the length: abcde0/20.

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

Formats the value using the given formatter.

impl Default for BitString<'_>

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BitString<'_>

impl<'a, const N: usize> From<&'a [u8; N]> for BitString<'a>

fn from(octets: &'a [u8; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a [u8]> for BitString<'a>

fn from(octets: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<Bits> for BitString<'_>

fn from(bits: Bits) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for BitString<'_>

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

Converts to this type from the input type.

impl<const N: usize> From<[u8; N]> for BitString<'_>

fn from(octets: [u8; N]) -> Self

Converts to this type from the input type.

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<'_>

By the bits, a string before those that it starts.

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 BitString<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BitString<'_>

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.