Struct jomini::ObjectReader
source · [−]pub struct ObjectReader<'data, 'tokens, E> { /* private fields */ }Expand description
A reader that will advance through an object
Implementations
sourceimpl<'data, 'tokens, E> ObjectReader<'data, 'tokens, E> where
E: Encoding + Clone,
impl<'data, 'tokens, E> ObjectReader<'data, 'tokens, E> where
E: Encoding + Clone,
sourcepub fn new(tape: &'tokens TextTape<'data>, encoding: E) -> Self
pub fn new(tape: &'tokens TextTape<'data>, encoding: E) -> Self
Create a new object reader from parsed data with encoded strings
sourcepub fn fields_len(&self) -> usize
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
sourcepub fn next_field(
&mut self
) -> Option<(ScalarReader<'data, E>, Option<Operator>, ValueReader<'data, 'tokens, E>)>
pub fn next_field(
&mut self
) -> Option<(ScalarReader<'data, E>, Option<Operator>, ValueReader<'data, 'tokens, E>)>
Advance the reader and return the next field
sourcepub fn next_fields(
&mut self
) -> Option<(ScalarReader<'data, E>, Vec<(Option<Operator>, ValueReader<'data, 'tokens, E>)>)>
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
sourcepub fn at_trailer(&mut self) -> Option<ArrayReader<'data, 'tokens, E>>
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
sourceimpl<'data, 'tokens, E: Clone> Clone for ObjectReader<'data, 'tokens, E>
impl<'data, 'tokens, E: Clone> Clone for ObjectReader<'data, 'tokens, E>
sourcefn clone(&self) -> ObjectReader<'data, 'tokens, E>
fn clone(&self) -> ObjectReader<'data, 'tokens, E>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl<'data, 'tokens, E> RefUnwindSafe for ObjectReader<'data, 'tokens, E> where
E: RefUnwindSafe,
impl<'data, 'tokens, E> Send for ObjectReader<'data, 'tokens, E> where
E: Send,
impl<'data, 'tokens, E> Sync for ObjectReader<'data, 'tokens, E> where
E: Sync,
impl<'data, 'tokens, E> Unpin for ObjectReader<'data, 'tokens, E> where
E: Unpin,
'data: 'tokens,
impl<'data, 'tokens, E> UnwindSafe for ObjectReader<'data, 'tokens, E> where
E: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more