Struct ion_c_sys::reader::IonCReaderHandle

pub struct IonCReaderHandle<'a> { /* fields omitted */ }

Wrapper over hREADER to make it easier to use readers in IonC correctly.

Specifically supports the Drop trait to make sure ion_reader_close is run. Access to the underlying hREADER pointer is done by de-referencing the handle.

Implementations

impl<'a> IonCReaderHandle<'a>

pub fn try_from_buf(
    src: &'a [u8],
    options: &mut ION_READER_OPTIONS
) -> Result<Self, IonCError>

Constructs a reader handle from a byte slice and given options.

Trait Implementations

impl<'_> Deref for IonCReaderHandle<'_>

type Target = hREADER

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> DerefMut for IonCReaderHandle<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'_> Drop for IonCReaderHandle<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> IonCReader for IonCReaderHandle<'a>

fn next(&mut self) -> IonCResult<ION_TYPE>

Advances the reader to the next value and returns the type.

fn get_type(&self) -> IonCResult<ION_TYPE>

Returns the type of the current position.

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

Steps in to the current container.

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

Steps out of the current container.

fn depth(&self) -> IonCResult<i32>

Returns the current container depth.

fn is_null(&self) -> IonCResult<bool>

Returns if the reader is positioned on a null value.

fn is_in_struct(&self) -> IonCResult<bool>

Returns if the reader is positioned within a struct value.

fn get_field_name(&mut self) -> IonCResult<StrSliceRef<'_>>

Returns the field name if the reader positioned within a structure.

fn get_annotations(&mut self) -> IonCResult<StrSlicesRef<'_>>

Retrieves the annotations associated with the current value.

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

Reads a bool value from the reader.

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

Reads an int value from the reader.

fn read_bigint(&mut self) -> IonCResult<BigInt>

Reads an int value from the reader as a BigInt.

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

Reads a float value from the reader.

fn read_bigdecimal(&mut self) -> IonCResult<BigDecimal>

Reads a bigdecimal value from the reader.

fn read_datetime(&mut self) -> IonCResult<IonDateTime>

Reads a timestamp value from the reader.

fn read_string(&mut self) -> IonCResult<StrSliceRef<'_>>

Reads a string/symbol value from the reader.

fn read_bytes(&mut self) -> IonCResult<Vec<u8>>

Reads a clob/blob value from the reader.

impl<'a> TryFrom<&'a [u8]> for IonCReaderHandle<'a>

type Error = IonCError

The type returned in the event of a conversion error.

fn try_from(src: &'a [u8]) -> Result<Self, Self::Error>

Constructs a reader from a byte slice with the default options.

impl<'a> TryFrom<&'a str> for IonCReaderHandle<'a>

type Error = IonCError

The type returned in the event of a conversion error.

fn try_from(src: &'a str) -> Result<Self, Self::Error>

Constructs a reader from a str slice with the default options.