Skip to main content

SampleStorage

Struct SampleStorage 

Source
pub struct SampleStorage { /* private fields */ }
Expand description

A validated sample storage domain.

Significant bits may be narrower than an integer storage word. Packed samples occupy exactly their significant-bit width. Floating-point samples must occupy an entire 16-, 32-, or 64-bit word.

Implementations§

Source§

impl SampleStorage

Source

pub fn new( class: SampleClass, significant_bits: u8, unit: StorageUnit, ) -> StorageResult<Self>

Validates a numeric class, significant-bit count, and physical unit.

§Errors

Rejects zero bits, more than 64 packed bits, significant widths larger than a byte or word, one-bit signed samples, and floating-point storage that is packed, byte-sized, padded, or not 16/32/64 bits wide.

Source

pub const fn class(self) -> SampleClass

Returns the sample’s numeric class.

Source

pub const fn significant_bits(self) -> u8

Returns the number of meaningful bits in the sample.

Source

pub const fn unit(self) -> StorageUnit

Returns the physical storage unit.

Source

pub const fn storage_bits(self) -> u8

Returns the number of bits charged for each stored sample.

Source

pub const fn byte_order(self) -> Option<ByteOrder>

Returns the byte order when the unit is a multi-byte word.

Source

pub const fn bit_order(self) -> Option<BitOrder>

Returns the packed-stream bit order, when applicable.

Trait Implementations§

Source§

impl Clone for SampleStorage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SampleStorage

Source§

impl Debug for SampleStorage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SampleStorage

Source§

impl Hash for SampleStorage

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 PartialEq for SampleStorage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SampleStorage

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.