Struct FrameNumber

pub struct FrameNumber(pub u64);

A frame number in the stream, as FLAC frames or samples

The frame number is stored as a UTF-8-like value where the total number of bytes is encoded in the initial byte.

byte 0	byte 1	byte 2	byte 3	byte 4	byte 5	byte 6
0xxxxxxx
110xxxxx	10xxxxxx
1110xxxx	10xxxxxx	10xxxxxx
11110xxx	10xxxxxx	10xxxxxx	10xxxxxx
111110xx	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx
1111110x	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx
11111110	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx	10xxxxxx

The x bits are the frame number, encoded from most-significant to least significant.

Tuple Fields

0: u64

Implementations

impl FrameNumber

pub fn try_increment(&mut self) -> Result<(), Error>

Attempt to increment frame number

Error

Returns an error if the frame number is too large

Trait Implementations

impl Clone for FrameNumber

fn clone(&self) -> FrameNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameNumber

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

Formats the value using the given formatter.

impl Default for FrameNumber

fn default() -> FrameNumber

Returns the “default value” for a type.

impl Display for FrameNumber

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

Formats the value using the given formatter.

impl FromBitStream for FrameNumber

type Error = Error

Error generated during parsing, such as io::Error

fn from_reader<R: BitRead + ?Sized>(r: &mut R) -> Result<Self, Error>

Parse Self from reader

impl PartialEq for FrameNumber

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

Tests for self and other values to be equal, and is used by ==.

const 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 ToBitStream for FrameNumber

type Error = Error

Error generated during building, such as io::Error

fn to_writer<W: BitWrite + ?Sized>(&self, w: &mut W) -> Result<(), Error>

Generate self to writer

fn bits<C>(&self) -> Result<C, Self::Error>

where C: Counter, Self: Sized,

Returns length of self in bits, if possible

fn bits_len<C, E>(&self) -> Result<C, Self::Error>

where C: Counter, E: Endianness, Self: Sized,

👎Deprecated since 4.0.0: use of bits() is preferred

Returns total length of self, if possible

impl Copy for FrameNumber

impl Eq for FrameNumber

impl StructuralPartialEq for FrameNumber