Struct SampleSize

pub struct SampleSize { /* private fields */ }

The size of a single sample as a total number of bits, and the number of “valid” bits.

The number of valid bits is always less than or equal to the total.

Implementations

impl SampleSize

pub const fn from_full_bits(total_bits: NonZeroU32) -> Self

Returns a SampleSize where all given bits are valid.

pub const fn from_partial_bits( valid_bits: NonZeroU32, total_bits: NonZeroU32, ) -> Option<Self>

Returns a SampleSize where some bits are valid, if the number of valid bits is less than or equal to the total bits.

pub const fn total_bits(&self) -> NonZeroU32

pub const fn total_bytes(&self) -> NonZeroU32

pub const fn valid_bits(&self) -> NonZeroU32

Trait Implementations

impl Clone for SampleSize

fn clone(&self) -> SampleSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleSize

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

Formats the value using the given formatter.

impl Display for SampleSize

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

Formats the value using the given formatter.

impl FromStr for SampleSize

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SampleSize

fn eq(&self, other: &SampleSize) -> 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 Copy for SampleSize

impl Eq for SampleSize

impl StructuralPartialEq for SampleSize