Struct ion_rs::binary::non_blocking::raw_binary_reader::RawBinaryReader

pub struct RawBinaryReader<A: AsRef<[u8]> + Expandable> { /* private fields */ }

A raw binary reader that pulls input bytes from a fixed buffer.

If any read operation fails due to the buffer containing incomplete data, that method will return IonError::Incomplete.

If the buffer (generic type A) is a Vec<u8>, then data can be appended to it between read operations. This can be useful when reading from a data source that is growing over time, such as when tailing a growing file, reading over the network, or waiting for user input. Applications can read from the buffer until they encounter an Incomplete. Then, when more data is available, they can use read_from or append_bytes to add that data to the buffer. Finally, they can retry the read operation that had previously failed.

Note that if the buffer runs out of data between top level values, this will be interpreted as the end of the stream. Applications can still add more data to the buffer and resume reading.

Implementations

impl<A: AsRef<[u8]> + Expandable> RawBinaryReader<A>

pub fn new(source: A) -> RawBinaryReader<A>

Constructs a RawBinaryReader from a value that can be viewed as a byte slice.

pub fn annotations_iter( &self ) -> impl Iterator<Item = IonResult<RawSymbolToken>> + '_

Creates an iterator that lazily reads the VarUInt symbol IDs in this value’s annotations wrapper. If the reader is not on a value or the current value does not have annotations, the iterator will be empty.

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

If the reader is currently positioned on a symbol value, parses that value into a SymbolId.

pub fn read_str_bytes(&mut self) -> IonResult<&[u8]>

If the reader is currently positioned on a string, returns the slice of bytes that represents that string’s UNVALIDATED utf-8 bytes. This method is available for performance optimization in scenarios where utf-8 validation may be unnecessary and/or a bottleneck. It is strongly recommended that you use read_str unless absolutely necessary.

pub fn read_blob_bytes(&mut self) -> IonResult<&[u8]>

If the reader is currently positioned on a blob, returns a slice containing its bytes.

pub fn read_clob_bytes(&mut self) -> IonResult<&[u8]>

If the reader is currently positioned on a clob, returns a slice containing its bytes.

pub fn header_length(&self) -> usize

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

Returns a slice containing the current value’s bytes. In the case of a container the raw bytes will consist of its field ID (if present), its annotations (if present), and its header. In the case of a non-container value, the bytes for the value itself is also included.

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

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

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

pub fn raw_annotations_bytes(&self) -> Option<&[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_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>

Trait Implementations

impl BufferedRawReader for RawBinaryReader<Vec<u8>>

fn append_bytes(&mut self, bytes: &[u8]) -> IonResult<()>

Copies the provided bytes to end of the reader’s input buffer.

fn read_from<R: Read>(&mut self, source: R, length: usize) -> IonResult<usize>

Tries to read length bytes from source. Unlike append_bytes, this method does not do any copying. A slice of the reader’s buffer is handed to source so it can be populated directly.

fn stream_complete(&mut self)

fn is_stream_complete(&self) -> bool

impl<A: Debug + AsRef<[u8]> + Expandable> Debug for RawBinaryReader<A>

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

Formats the value using the given formatter.

impl From<Vec<u8, Global>> for RawBinaryReader<Vec<u8>>

fn from(source: Vec<u8>) -> Self

Converts to this type from the input type.

impl<A: AsRef<[u8]> + Expandable> IonReader for RawBinaryReader<A>

fn read_str(&mut self) -> IonResult<&str>

If the reader is currently positioned on a string, returns a &str containing its text.

type Item = RawStreamItem

The type returned by calls to Self::next, indicating the next entity in the stream. Reader implementations representing different levels of abstraction will surface different sets of encoding artifacts. While an application-level Reader would only surface Ion values, a lower level Reader might surface symbol tables, Ion version markers, etc.

type Symbol = RawSymbolToken

The types used to represent field names, annotations, and symbol values at this Reader’s level of abstraction.

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<Self::Item>

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 current(&self) -> Self::Item

Returns a value describing the stream entity over which the Reader is currently positioned. Depending on the Reader’s level of abstraction, that entity may or may not be an Ion value.

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

If the current item is a value, returns that value’s Ion type. Otherwise, returns None.

fn annotations<'a>( &'a self ) -> Box<dyn Iterator<Item = IonResult<Self::Symbol>> + 'a>

Returns an iterator that will yield each of the annotations for the current value in order. If there is no current value, returns an empty iterator.

fn has_annotations(&self) -> bool

If the reader is positioned over a value with one or more annotations, returns true. Otherwise, returns false.

fn field_name(&self) -> IonResult<Self::Symbol>

If the current item is a field within a struct, returns Ok(_) with a Self::Symbol representing the field’s name; otherwise, returns an crate::IonError::IllegalOperation.

fn is_null(&self) -> bool

Returns true if the reader is currently positioned over an Ion null of any type.

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

Attempts to read the current item as an Ion null and return its Ion type. If the current item is not a null or an IO error is encountered while reading, returns crate::IonError.

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

Attempts to read the current item as an Ion boolean and return it as a bool. If the current item is not a boolean or an IO error is encountered while reading, returns crate::IonError.

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

Attempts to read the current item as an Ion integer and return it as an i64. If the current item is not an integer, the integer is too large to be represented as an i64, or an IO error is encountered while reading, returns crate::IonError.

fn read_int(&mut self) -> IonResult<Int>

Attempts to read the current item as an Ion integer and return it as an Int. If the current item is not an integer or an IO error is encountered while reading, returns crate::IonError.

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

Attempts to read the current item as an Ion float and return it as an f32. If the current item is not a float or an IO error is encountered while reading, returns crate::IonError.

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

Attempts to read the current item as an Ion float and return it as an f64. If the current item is not a float or an IO error is encountered while reading, returns crate::IonError.

fn read_decimal(&mut self) -> IonResult<Decimal>

Attempts to read the current item as an Ion decimal and return it as a crate::Decimal. If the current item is not a decimal or an IO error is encountered while reading, returns crate::IonError.

fn read_string(&mut self) -> IonResult<Str>

Attempts to read the current item as an Ion string and return it as a String. If the current item is not a string or an IO error is encountered while reading, returns crate::IonError.

fn read_symbol(&mut self) -> IonResult<Self::Symbol>

Attempts to read the current item as an Ion symbol and return it as a Self::Symbol. If the current item is not a symbol or an IO error is encountered while reading, returns crate::IonError.

fn read_blob(&mut self) -> IonResult<Blob>

Attempts to read the current item as an Ion blob and return it as a Vec<u8>. If the current item is not a blob or an IO error is encountered while reading, returns crate::IonError.

fn read_clob(&mut self) -> IonResult<Clob>

Attempts to read the current item as an Ion clob and return it as a Vec<u8>. If the current item is not a clob or an IO error is encountered while reading, returns crate::IonError.

fn read_timestamp(&mut self) -> IonResult<Timestamp>

Attempts to read the current item as an Ion timestamp and return crate::Timestamp. If the current item is not a timestamp or an IO error is encountered while reading, returns crate::IonError.

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. The application must call Self::next() to advance to the first child value. If the current value is not a container, returns crate::IonError.

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

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

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

If the reader is positioned at the top level, returns None. Otherwise, returns Some(_) with the parent container’s crate::IonType.

fn depth(&self) -> usize

Returns a usize indicating the Reader’s current level of nesting. That is: the number of times the Reader has stepped into a container without later stepping out. At the top level, this method returns 0.

fn number_of_annotations(&self) -> usize

Returns the number of annotations on the current value. If there is no current value, returns zero.