Struct BlockHeader

pub struct BlockHeader {
    pub last: bool,
    pub block_type: BlockType,
    pub size: BlockSize,
}

A FLAC metadata block header

Bits	Field	Meaning
1	last	final metadata block in file
7	block_type	type of block
24	size	block size, in bytes

Example

use bitstream_io::{BitReader, BitRead, BigEndian};
use flac_codec::metadata::{BlockHeader, BlockType};

let data: &[u8] = &[0b1_0000000, 0x00, 0x00, 0x22];
let mut r = BitReader::endian(data, BigEndian);
assert_eq!(
    r.parse::<BlockHeader>().unwrap(),
    BlockHeader {
        last: true,                         // 0b1
        block_type: BlockType::Streaminfo,  // 0b0000000
        size: 0x00_00_22u16.into(),         // 0x00, 0x00, 0x22
    },
);

Fields

last: bool

Whether we are the final block

block_type: BlockType

Our block type

size: BlockSize

Our block size, in bytes

Trait Implementations

impl Debug for BlockHeader

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

Formats the value using the given formatter.

impl FromBitStream for BlockHeader

type Error = Error

Error generated during parsing, such as io::Error

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

Parse Self from reader

impl PartialEq for BlockHeader

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

type Error = Error

Error generated during building, such as io::Error

fn to_writer<W: BitWrite + ?Sized>(&self, w: &mut W) -> Result<(), Self::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 Eq for BlockHeader

impl StructuralPartialEq for BlockHeader