Struct binjs::io::entropy::write::Encoder

[+] Show declaration

pub struct Encoder { /* fields omitted */ }

[−] Expand description

An entropy encoder, based on the Opus bit-level entropy coding.

Methods

impl Encoder[−]

pub fn new(path: Option<&Path>, options: Options) -> Encoder[−]

Create a new Encoder.

Note that cloning options is pretty cheap, as it is mostly a bunch of Rc<>.

Trait Implementations

impl TokenWriter for Encoder[+]

[+] Show hidden undocumented items

type Data = Box<[u8]>

The type of data generated by this writer. Typically some variant of Vec<u8>.

fn done(self) -> Result<<Encoder as TokenWriter>::Data, TokenWriterError>[−]

Finish writing, produce data.

fn bool_at(
    &mut self,
    value: Option<bool>,
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write single bool.

fn string_enum_at(
    &mut self,
    value: &SharedString,
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a single UTF-8 value from a string enumeration.

fn enter_tagged_tuple_at(
    &mut self,
    _node: &(dyn Node + 'static),
    tag: &InterfaceName,
    _children: &[&FieldName],
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a tagged tuple.

fn float_at(
    &mut self,
    value: Option<f64>,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a single number.

fn unsigned_long_at(
    &mut self,
    value: u32,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a single u32.

fn string_at(
    &mut self,
    value: Option<&SharedString>,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a single UTF-8 string.

fn identifier_name_at(
    &mut self,
    value: Option<&IdentifierName>,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>

fn property_key_at(
    &mut self,
    value: Option<&PropertyKey>,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>

fn enter_list_at(
    &mut self,
    len: usize,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write a list.

fn enter_scoped_dictionary_at(
    &mut self,
    name: &SharedString,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Signal that, from this point, writing is expected to use a specialized dictionary. Use of the specialized dictionary will stop at exit_scoped_dictionary_at.

fn exit_scoped_dictionary_at(
    &mut self,
    name: &SharedString,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Signal that, from this point, writing is expected to return to the previous specialized dictionary.

fn offset_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>[−]

Write the number of bytes left in this tuple.

fn exit_tagged_tuple_at(
    &mut self,
    _node: &(dyn Node + 'static),
    _tag: &InterfaceName,
    _children: &[&FieldName],
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>

fn exit_list_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenWriterError>