Struct ion_rs::BinaryIonCursor

pub struct BinaryIonCursor<R> where
    R: IonDataSource,  { /* fields omitted */ }

Implementations

impl<T> BinaryIonCursor<Cursor<T>> where
    T: AsRef<[u8]>, 

Additional functionality that’s only available if the data source is in-memory, such as a Vec or &u8).

pub fn field_id_length(&self) -> Option<usize>

pub fn field_id_offset(&self) -> Option<usize>

pub fn field_id_range(&self) -> Option<Range<usize>>

pub fn annotations_length(&self) -> Option<usize>

pub fn annotations_offset(&self) -> Option<usize>

pub fn annotations_range(&self) -> Option<Range<usize>>

pub fn header_length(&self) -> usize

pub fn header_offset(&self) -> usize

pub fn header_range(&self) -> Range<usize>

pub fn value_length(&self) -> usize

pub fn value_offset(&self) -> usize

pub fn value_range(&self) -> Range<usize>

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

Returns a slice containing the entirety of this encoded value, including its field ID (if present), its annotations (if present), its header, and the encoded value itself. Calling this function does not advance the cursor.

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

Returns a slice containing the current value’s header’s raw bytes without advancing the cursor. Includes the type descriptor byte and any bytes used to represent the length field.

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

Returns a slice containing the current value’s raw bytes (not including its field ID, annotations, or type descriptor byte) without advancing the cursor.

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

Returns a slice containing the current value’s raw field ID bytes (if present) without advancing the cursor.

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

Returns a slice containing the current value’s annotations (if any) without advancing the cursor.

impl<R> BinaryIonCursor<R> where
    R: IonDataSource, 

pub fn new(data_source: R) -> Self

pub fn is_null(&self) -> bool

Trait Implementations

impl<R: IonDataSource> Cursor for BinaryIonCursor<R>

type DataSource = R

fn ion_version(&self) -> (u8, u8)

Returns the (major, minor) version of the Ion stream being read. If ion_version is called before an Ion Version Marker has been read, the version (1, 0) will be returned.

fn next(&mut self) -> IonResult<Option<StreamItem>>

Attempts to advance the cursor to the next value in the stream at the current depth. If no value is encountered, returns None; otherwise, returns the Ion type of the next value.

fn ion_type(&self) -> Option<IonType>

Returns the Ion type of the value currently positioned under the cursor. If the cursor is not positioned over a value, returns None.

fn is_null(&self) -> bool

Returns true if the current value is a null of any type; otherwise, returns false.

fn annotation_ids(&self) -> &[SymbolId]

Returns a slice containing all of the annotation symbol IDs for the current value. If there is no current value, returns an empty slice.

fn field_id(&self) -> Option<SymbolId>

If the current value is a field within a struct, returns the symbol ID of that field’s name; otherwise, returns None.

fn read_null(&mut self) -> IonResult<Option<IonType>>

If the current value is a null, returns the Ion type of the null; otherwise, returns None.

fn read_bool(&mut self) -> IonResult<Option<bool>>

If the current value is a boolean, returns its value as a bool; otherwise, returns None.

fn read_i64(&mut self) -> IonResult<Option<i64>>

If the current value is an integer, returns its value as an i64; otherwise, returns None.

fn read_f32(&mut self) -> IonResult<Option<f32>>

If the current value is a float, returns its value as an f32; otherwise, returns None.

fn read_f64(&mut self) -> IonResult<Option<f64>>

If the current value is a float, returns its value as an f64; otherwise, returns None.

fn read_big_decimal(&mut self) -> IonResult<Option<BigDecimal>>

If the current value is a decimal, returns its value as an BigDecimal; otherwise, returns None.

fn read_string(&mut self) -> IonResult<Option<String>>

If the current value is a string, returns its value as a String; otherwise, returns None.

fn string_ref_map<F, T>(&mut self, f: F) -> IonResult<Option<T>> where
    F: FnOnce(&str) -> T, 

Runs the provided closure, passing in a reference to the string to be read and allowing a calculated value of any type to be returned. When possible, string_ref_map will pass a reference directly to the bytes in the input buffer rather than allocating a new string.

fn string_bytes_map<F, T>(&mut self, f: F) -> IonResult<Option<T>> where
    F: FnOnce(&[u8]) -> T, 

Runs the provided closure, passing in a reference to the unparsed, unvalidated bytes of the string to be read and allowing a calculated value of any type to be returned. When possible, string_bytes_map will pass a reference directly to the bytes in the input buffer rather than copying the data.

fn read_symbol_id(&mut self) -> IonResult<Option<SymbolId>>

If the current value is a symbol, returns its value as a SymbolId; otherwise, returns None.

fn read_blob_bytes(&mut self) -> IonResult<Option<Vec<u8>>>

If the current value is a blob, returns its value as a Vec; otherwise, returns None.

fn blob_ref_map<F, T>(&mut self, f: F) -> IonResult<Option<T>> where
    F: FnOnce(&[u8]) -> T, 

Runs the provided closure, passing in a reference to the blob to be read and allowing a calculated value of any type to be returned. When possible, blob_ref_map will pass a reference directly to the bytes in the input buffer rather than allocating a new array.

fn clob_ref_map<F, T>(&mut self, f: F) -> IonResult<Option<T>> where
    F: FnOnce(&[u8]) -> T, 

Runs the provided closure, passing in a reference to the clob to be read and allowing a calculated value of any type to be returned. When possible, clob_ref_map will pass a reference directly to the bytes in the input buffer rather than allocating a new array.

fn read_clob_bytes(&mut self) -> IonResult<Option<Vec<u8>>>

If the current value is a clob, returns its value as a Vec; otherwise, returns None.

fn read_datetime(&mut self) -> IonResult<Option<DateTime<FixedOffset>>>

If the current value is a timestamp, returns its value as a DateTime; otherwise, returns None.

fn step_in(&mut self) -> IonResult<()>

If the current value is a container (i.e. a struct, list, or s-expression), positions the cursor at the beginning of that container’s sequence of child values. If the current value is not a container, returns Err.

fn step_out(&mut self) -> IonResult<()>

Positions the cursor at the end of the container currently being traversed. Calling next() will position the cursor over the value that follows the container. If the cursor is not in a container (i.e. it is already at the top level), returns Err.

fn depth(&self) -> usize