Skip to main content

SampleEncoding

Struct SampleEncoding 

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

Storage word, significant code bits and their placement within the word.

Compatibility encoding from the existing unpublished media API. It mirrors zenpixels::sample::SampleEncoding; removing this duplicate requires the coordinated media migration to that type and its published dependency floor. A 10-bit sample in a 16-bit word is new(U16, 10, 0) (LSB-aligned) or new(U16, 10, 6) (MSB-aligned); it is never relabelled as a full-range 16-bit value.

Implementations§

Source§

impl SampleEncoding

Source

pub const U8: SampleEncoding

Eight-bit codes in 8-bit words.

Source

pub const fn new( storage: ChannelType, code_bits: u8, bit_shift: u8, ) -> Result<SampleEncoding, SampleEncodingError>

code_bits significant bits, shifted left by bit_shift, in a storage word.

§Errors

A SampleEncodingError for an unsupported word or a code that does not fit.

Source

pub const fn storage(self) -> ChannelType

The storage word.

Source

pub const fn code_bits(self) -> u8

Significant bits per code.

Source

pub const fn bit_shift(self) -> u8

Left shift of the code within the word.

Source

pub const fn bytes_per_sample(self) -> usize

Bytes per stored sample.

Trait Implementations§

Source§

impl Clone for SampleEncoding

Source§

fn clone(&self) -> SampleEncoding

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 SampleEncoding

Source§

impl Debug for SampleEncoding

Source§

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

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

impl Eq for SampleEncoding

Source§

impl Hash for SampleEncoding

Source§

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

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 SampleEncoding

Source§

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

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

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.