Struct Block

pub struct Block<'a> {
    pub track: u64,
    pub timestamp: i16,
    pub invisible: bool,
    pub lacing: Option<BlockLacing>,
    /* private fields */
}

A typed interpretation of the Matroska “Block” element.

This struct has fields specific to the Block element as defined by the Matroska Spec. This struct implements TryFrom<&MatroskaSpec> and Into<MatroskaSpec> to simplify coercion to and from regular variants.

Example

use webm_iterable::matroska_spec::{MatroskaSpec, Block};

let variant = &MatroskaSpec::Block(vec![0x83,0x00,0x01,0x9d,0x00,0x00,0x00]);
let mut block: Block = variant.try_into().unwrap();
assert_eq!(3, block.track);

Fields

track: u64

timestamp: i16

invisible: bool

lacing: Option<BlockLacing>

Implementations

impl<'a> Block<'a>

pub fn raw_frame_data(&self) -> &[u8]

Reads the raw frame data of the block.

Frame data can be formatted differently depending on the block lacing. Generally, it is easier to use Self::read_frame_data() rather than this method to access the frames in the block. This method is provided in the event raw packet data needs to be handled in a special way (for example, if the data is encrypted).

pub fn read_frame_data(&self) -> Result<Vec<Frame<'_>>, WebmCoercionError>

Reads the frames encoded in the block.

This method outputs the binary frames encoded in the block, taking into account any block lacing. Details on block lacing can be found in the Matroska spec.

Errors

This method can return an error if the frame data is malformed.

pub fn set_frame_data(&mut self, frames: &Vec<Frame<'_>>)

Updates the frame data contained in the block.

This method writes frame data to a newly allocated vector owned by the block. Future calls to Self::read_frame_data() and Self::raw_frame_data() will use the data set via this method.

Panics

This method can panic if the block has its lacing set as [’BlockLacing::FixedSize`] and the input frames are not all the same length.

pub fn new_uncheked( track: u64, timestamp: i16, invisible: bool, lacing: Option<BlockLacing>, frame_data: &'a [u8], ) -> Self

Creates a new block with the given data.

Primarily used if you would like to write with a given frame. For example, when you want to remux a video with libvpx.

Trait Implementations

impl<'a> Clone for Block<'a>

fn clone(&self) -> Block<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Block<'a>

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

Formats the value using the given formatter.

impl<'a> From<Block<'a>> for MatroskaSpec

fn from(block: Block<'_>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<&'a [u8]> for Block<'a>

type Error = WebmCoercionError

The type returned in the event of a conversion error.

fn try_from(data: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a MatroskaSpec> for Block<'a>

type Error = WebmCoercionError

The type returned in the event of a conversion error.

fn try_from(value: &'a MatroskaSpec) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Vec<u8>> for Block<'a>

type Error = WebmCoercionError

The type returned in the event of a conversion error.

fn try_from(value: &'a Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.