Struct ring::bits::BitLength

#[repr(transparent)]
pub struct BitLength<T = usize>(T);

The length of something, in bits.

This can represent a bit length that isn’t a whole number of bytes.

Tuple Fields

0: T

Implementations

impl<T: Copy> BitLength<T>

pub fn as_bits(self) -> T

The number of bits this bit length represents, as a usize.

impl BitLength<usize>

pub const fn from_usize_bits(bits: usize) -> Self

Constructs a BitLength from the given length in bits.

pub(crate) fn half_rounded_up(&self) -> Self

pub fn as_usize_bytes_rounded_up(&self) -> usize

The bit length, rounded up to a whole number of bytes.

pub(crate) fn try_sub_1(self) -> Result<Self, Unspecified>

Trait Implementations

impl<T: Clone> Clone for BitLength<T>

fn clone(&self) -> BitLength<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BitLength<T>

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

Formats the value using the given formatter.

impl FromUsizeBytes for BitLength<usize>

fn from_usize_bytes(bytes: usize) -> Result<Self, Unspecified>

Constructs a BitLength from the given length in bytes.

impl FromUsizeBytes for BitLength<u64>

fn from_usize_bytes(bytes: usize) -> Result<Self, Unspecified>

Constructs a BitLength from the given length in bytes.

impl<T: PartialEq> PartialEq for BitLength<T>

fn eq(&self, other: &BitLength<T>) -> bool

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

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.

impl<T: PartialOrd> PartialOrd for BitLength<T>

fn partial_cmp(&self, other: &BitLength<T>) -> 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<T: Copy> Copy for BitLength<T>

impl<T: Eq> Eq for BitLength<T>

impl<T> StructuralPartialEq for BitLength<T>