Trait ebml_iterable::specs::EbmlTag

source · 
pub trait EbmlTag<T>
where
    T: Clone,
{
    // Required methods
    fn get_id(&self) -> u64;
    fn as_unsigned_int(&self) -> Option<&u64>;
    fn as_signed_int(&self) -> Option<&i64>;
    fn as_utf8(&self) -> Option<&str>;
    fn as_binary(&self) -> Option<&[u8]>;
    fn as_float(&self) -> Option<&f64>;
    fn as_master(&self) -> Option<&Master<T>>;
}
Expand description

This trait, along with EbmlSpecification, should be implemented to define a specification so that EBML can be parsed correctly. Typically implemented on an Enum of tag variants.

Any specification using EBML can take advantage of this library to parse or write binary data. As stated in the docs, TagWriter needs nothing special if you stick with the write_raw method, but TagIterator requires a struct implementing this trait. Custom specification implementations can refer to webm-iterable as an example.

This trait and EbmlSpecification are typically implemented simultaneously. They are separate traits as they have primarily different uses - EbmlSpecification should be brought into scope when dealing with the specification as a whole, whereas EbmlTag should be brought into scope when dealing with specific tags.

Required Methods§

source

fn get_id(&self) -> u64

Gets the id of self.

Implementors can reference webm-iterable for an example.

source

fn as_unsigned_int(&self) -> Option<&u64>

Gets a reference to the data contained in self as an unsigned integer.

This function must return None if the associated data type of self is not TagDataType::UnsignedInt. Implementors can reference webm-iterable for an example.

source

fn as_signed_int(&self) -> Option<&i64>

Gets a reference to the data contained in self as an integer.

This function must return None if the associated data type of self is not TagDataType::Integer. Implementors can reference webm-iterable for an example.

source

fn as_utf8(&self) -> Option<&str>

Gets a reference to the data contained in self as string slice.

This function must return None if the associated data type of self is not TagDataType::Utf8. Implementors can reference webm-iterable for an example.

source

fn as_binary(&self) -> Option<&[u8]>

Gets a reference to the data contained in self as binary data.

This function must return None if the associated data type of self is not TagDataType::Binary. Implementors can reference webm-iterable for an example.

source

fn as_float(&self) -> Option<&f64>

Gets a reference to the data contained in self as float data.

This function must return None if the associated data type of self is not TagDataType::Float. Implementors can reference webm-iterable for an example.

source

fn as_master(&self) -> Option<&Master<T>>

Gets a reference to master data contained in self.

This function must return None if the associated data type of self is not TagDataType::Master. Implementors can reference webm-iterable for an example.

Implementors§