Struct TinyWaveformPreviewColumn

pub struct TinyWaveformPreviewColumn { /* private fields */ }

Single Column value in a Tiny Waveform Preview.

Implementations

impl TinyWaveformPreviewColumn

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl TinyWaveformPreviewColumn

pub const fn into_bytes(self) -> [u8; 1]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 1]) -> Self

Converts the given bytes directly into the bitfield struct.

impl TinyWaveformPreviewColumn

pub fn height(&self) -> <B4 as Specifier>::InOut

Returns the value of height. Height of the Column in pixels.

pub fn height_or_err( &self, ) -> Result<<B4 as Specifier>::InOut, InvalidBitPattern<<B4 as Specifier>::Bytes>>

Returns the value of height.

Errors

If the returned value contains an invalid bit pattern for height. Height of the Column in pixels.

pub fn with_height(self, new_val: <B4 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of height set to the given value.

Panics

If the given value is out of bounds for height. Height of the Column in pixels.

pub fn with_height_checked( self, new_val: <B4 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of height set to the given value.

Errors

If the given value is out of bounds for height. Height of the Column in pixels.

pub fn set_height(&mut self, new_val: <B4 as Specifier>::InOut)

Sets the value of height to the given value.

Panics

If the given value is out of bounds for height. Height of the Column in pixels.

pub fn set_height_checked( &mut self, new_val: <B4 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of height to the given value.

Errors

If the given value is out of bounds for height. Height of the Column in pixels.

Trait Implementations

impl BinRead for TinyWaveformPreviewColumn

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given [Endian] and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl BinWrite for TinyWaveformPreviewColumn

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given [Endian] and arguments.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl CheckTotalSizeMultipleOf8 for TinyWaveformPreviewColumn

type Size = TotalSize<BitCount</// Single Column value in a Tiny Waveform Preview.>>

impl Clone for TinyWaveformPreviewColumn

fn clone(&self) -> TinyWaveformPreviewColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TinyWaveformPreviewColumn

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

Formats the value using the given formatter.

impl Default for TinyWaveformPreviewColumn

fn default() -> Self

Returns the “default value” for a type.

impl From<[u8; 1]> for TinyWaveformPreviewColumn

fn from(bytes: [u8; 1]) -> Self

Converts to this type from the input type.

impl From<TinyWaveformPreviewColumn> for [u8; 1]

fn from(bytes: TinyWaveformPreviewColumn) -> Self

Converts to this type from the input type.

impl PartialEq for TinyWaveformPreviewColumn

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

const ENDIAN: EndianKind

The endianness of the type.

impl WriteEndian for TinyWaveformPreviewColumn

const ENDIAN: EndianKind

The endianness of the type.

impl Copy for TinyWaveformPreviewColumn

impl Eq for TinyWaveformPreviewColumn

impl StructuralPartialEq for TinyWaveformPreviewColumn