Struct IonCWriterHandle

pub struct IonCWriterHandle<'a> { /* private fields */ }

Wrapper over hWRITER to make it easier to use writers in IonC correctly.

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

See also:

• IonCWriter
• IonCValueWriter

Implementations

impl<'a> IonCWriterHandle<'a>

pub fn new_buf( buf: &'a mut [u8], options: &mut ION_WRITER_OPTIONS, ) -> Result<Self, IonCError>

Construct a writer to a given mutable slice with options.

pub fn new_buf_mode( buf: &'a mut [u8], mode: WriterMode, ) -> Result<Self, IonCError>

Construct a text/binary mode writer with otherwise default options.

Trait Implementations

impl Deref for IonCWriterHandle<'_>

type Target = *mut _ion_writer

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for IonCWriterHandle<'_>

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

Mutably dereferences the value.

impl Drop for IonCWriterHandle<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl IonCAnnotationsFieldWriter for IonCWriterHandle<'_>

type AFValueWriter = IonCWriterHandle<'_>

The associated type of value writer when writing within annotations/field context

fn write_annotations_and_field<'a, A, F, FN>( &mut self, possible_annotations: A, possible_field: F, applier: FN, ) -> IonCResult<()>

where A: Into<Option<&'a [&'a str]>>, F: Into<Option<&'a str>>, FN: Fn(&mut Self::AFValueWriter) -> IonCResult<()>,

Writes a value within a context of annotations and/or a field name

impl IonCValueWriter for IonCWriterHandle<'_>

fn write_null(&mut self, tid: ION_TYPE) -> IonCResult<()>

Writes a null value.

fn write_bool(&mut self, value: bool) -> IonCResult<()>

Writes a bool value.

fn write_i64(&mut self, value: i64) -> IonCResult<()>

Writes an int value.

fn write_bigint(&mut self, value: &BigInt) -> IonCResult<()>

Writes an int value.

fn write_f64(&mut self, value: f64) -> IonCResult<()>

Writes a float value.

fn write_bigdecimal(&mut self, value: &BigDecimal) -> IonCResult<()>

Writes a decimal value.

fn write_datetime(&mut self, value: &IonDateTime) -> IonCResult<()>

Writes a timestamp value.

fn write_symbol(&mut self, value: &str) -> IonCResult<()>

Writes a symbol value.

fn write_string(&mut self, value: &str) -> IonCResult<()>

Writes a string value.

fn write_clob(&mut self, value: &[u8]) -> IonCResult<()>

Writes a clob value.

fn write_blob(&mut self, value: &[u8]) -> IonCResult<()>

Writes a blob value.

fn start_container(&mut self, tid: ION_TYPE) -> IonCResult<()>

Starts a container.

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

Finishes a container.

impl<'a> IonCWriter<'a> for IonCWriterHandle<'a>

fn finish(&mut self) -> IonCResult<usize>

Finalizes writing for the writer and returns the amount of bytes written.

fn field<'b, 'c>( &'b mut self, field: &'c str, ) -> IonCAnnotationsFieldWriterContext<'b, 'c, Self>

Returns a lifetime safe writing context for a field.

fn annotations<'b, 'c>( &'b mut self, annotations: &'c [&'c str], ) -> IonCAnnotationsFieldWriterContext<'b, 'c, Self>

Returns a lifetime safe writing context for annotations.