Struct binjs::io::multipart::TreeTokenReader

pub struct TreeTokenReader { /* fields omitted */ }

Methods

impl TreeTokenReader

pub fn new<R>(reader: R) -> Result<TreeTokenReader, TokenReaderError> where
    R: Read + Seek, 

Trait Implementations

impl FileStructurePrinter for TreeTokenReader

fn enable_file_structure_print(&mut self)

Enables printing the binary representation and the structural interpretation.

fn disable_file_structure_print(&mut self)

Disables printing the binary representation and the structural interpretation.

fn is_file_structure_print_enabled(&mut self) -> bool

True if file structure print is enabled. With default implementation, nothing is printed.

fn prepare_file_structure_column(&mut self)

Prints the column separator ("# " characters), and padding before it if necessary.

fn newline_for_file_structure_print(&mut self)

Prints newline after printing the structural interpretation column. The implementation is supposed to print newline character(s) and also reset the current column position internally, in order to print the right number of spaces in prepare_file_structure_column.

impl TokenReader for TreeTokenReader

fn poison(&mut self)

Poison the reader, ensuring that it will never be used for reading again.

fn string_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<Option<SharedString>, TokenReaderError>

Read a single UTF-8 string.

fn float_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<Option<f64>, TokenReaderError>

Read a single f64. Note that all numbers are f64.

fn unsigned_long_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<u32, TokenReaderError>

Read a single u32.

fn bool_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<Option<bool>, TokenReaderError>

Read a single bool.

fn offset_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<u32, TokenReaderError>

Read a single u32.

fn enter_list_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<u32, TokenReaderError>

Start reading a list.

Returns an extractor for that list and the number of elements in the list. Before dropping the sub-extractor, callers MUST either reach the end of the list or call skip().

fn enter_tagged_tuple_at(
    &mut self,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(InterfaceName, Option<Rc<Box<[FieldName]>>>), TokenReaderError>

Start reading a tagged tuple.

Returns the tag name, None for fields and a sub-extractor dedicated to that tuple. The sub-extractor MUST be consumed entirely.

fn string_enum_at(
    &mut self,
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<SharedString, TokenReaderError>

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

fn identifier_name_at(
    &mut self,
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<Option<IdentifierName>, TokenReaderError>

Read a single identifier name.

fn property_key_at(
    &mut self,
    path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<Option<PropertyKey>, TokenReaderError>

Read a single property name.

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

Finish reading a list.

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

Finish reading a tagged tuple.

fn enter_scoped_dictionary_at(
    &mut self,
    _name: &SharedString,
    _path: &Path<InterfaceName, (usize, FieldName)>
) -> Result<(), TokenReaderError>

Signal that, from this point, reading 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<(), TokenReaderError>

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