Struct jomini::ObjectReader

pub struct ObjectReader<'data, 'tokens, E> { /* fields omitted */ }

A reader that will advance through an object

Implementations

impl<'data, 'tokens, E> ObjectReader<'data, 'tokens, E> where
    E: Encoding + Clone, 

pub fn new(tape: &'tokens TextTape<'data>, encoding: E) -> Self

Create a new object reader from parsed data with encoded strings

pub fn fields_len(&self) -> usize

Return the number of key value pairs that the object contains. Does not count the object trailer if present

pub fn next_field(
    &mut self
) -> Option<(ScalarReader<'data, E>, Option<Operator>, ValueReader<'data, 'tokens, E>)>

Advance the reader and return the next field

pub fn next_fields(
    &mut self
) -> Option<(ScalarReader<'data, E>, Vec<(Option<Operator>, ValueReader<'data, 'tokens, E>)>)>

Advance the reader and return all fields that share the same key in the object

pub fn at_trailer(&mut self) -> Option<ArrayReader<'data, 'tokens, E>>

Exposes the object trailer at the end of the object if it exists. It is the responsibility of the caller to make sure they are at the end of the object (where the trailer would be located). An object trailer is looks like:

brittany_area = { color = { 10 10 10 } 100 200 300 }

Trait Implementations

impl<'data, 'tokens, E: Clone> Clone for ObjectReader<'data, 'tokens, E>

fn clone(&self) -> ObjectReader<'data, 'tokens, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data, 'tokens, E: Debug> Debug for ObjectReader<'data, 'tokens, E>

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

Formats the value using the given formatter.