Struct ion_rs::binary::raw_binary_writer::RawBinaryWriter

pub struct RawBinaryWriter<W: Write> { /* private fields */ }

A system-level streaming binary Ion writer. This writer does not provide symbol table management; symbol-related operations (e.g. setting field IDs and annotations or writing symbol values) require a valid symbol ID to be provided by the caller.

To produce a valid binary Ion stream, the writer MUST call Writer::write_ion_version_marker before writing any data.

Implementations

impl<W: Write> RawBinaryWriter<W>

pub fn clear_annotations(&mut self)

pub fn has_annotations(&self) -> bool

pub fn write_symbol_id(&mut self, symbol_id: SymbolId) -> IonResult<()>

pub fn set_field_id(&mut self, field_id: SymbolId)

pub fn output(&self) -> &W

Returns a reference to the underlying io::Write implementation.

pub fn output_mut(&mut self) -> &mut W

Returns a mutable reference to the underlying io::Write implementation. Modifying the underlying sink is an inherently risky operation and can result in unexpected behavior. It is not recommended for most use cases.

pub fn add_annotation<A: AsRawSymbolTokenRef>(&mut self, annotation: A)

Trait Implementations

impl<W: Debug + Write> Debug for RawBinaryWriter<W>

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

Formats the value using the given formatter.

impl<'a, W: Write> Writer for RawBinaryWriter<W>

fn write_null(&mut self, ion_type: IonType) -> IonResult<()>

Writes an Ion null of the specified type.

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

Writes an Ion boolean with the specified value.

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

Writes an Ion integer with the specified value.

fn write_integer(&mut self, value: &Integer) -> IonResult<()>

Writes an Ion integer with the specified value.

fn write_f32(&mut self, value: f32) -> IonResult<()>

Writes an Ion float with the specified value.

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

Writes an Ion float with the specified value.

fn write_decimal(&mut self, value: &Decimal) -> IonResult<()>

Writes an Ion decimal with the specified value.

fn write_timestamp(&mut self, value: &Timestamp) -> IonResult<()>

Writes an Ion timestamp with the specified value.

fn step_in(&mut self, ion_type: IonType) -> IonResult<()>

Starts a container of the specified Ion type. If ion_type is not a List, SExpression, or Struct, step_in will return an Err.

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

Ends the current container. If the writer is at the top level, step_out will return an Err.

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

Writes any buffered data to the sink. This method can only be called when the writer is at the top level.

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

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

fn write_ion_version_marker(&mut self, major: u8, minor: u8) -> IonResult<()>

Writes an Ion version marker to the output stream.

fn supports_text_symbol_tokens(&self) -> bool

Returns true if this RawWriter supports writing field names, annotations, and symbol values directly as text; otherwise, returns false.

fn set_annotations<I, A>(&mut self, annotations: I) where
    A: AsRawSymbolTokenRef,
    I: IntoIterator<Item = A>, 

Sets a list of annotations that will be applied to the next value that is written.

fn write_symbol<A: AsRawSymbolTokenRef>(&mut self, value: A) -> IonResult<()>

Writes an Ion symbol with the specified value to the output stream.

fn write_string<S: AsRef<str>>(&mut self, value: S) -> IonResult<()>

Writes an Ion string with the specified value to the output stream.

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

Writes an Ion clob with the specified value to the output stream.

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

Writes an Ion blob with the specified value to the output stream.

fn set_field_name<A: AsRawSymbolTokenRef>(&mut self, name: A)

Sets the current field name to name. If the TextWriter is currently positioned inside of a struct, the field name will be written before the next value. Otherwise, it will be ignored.

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

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

fn depth(&self) -> usize

Returns the number of containers that the writer has stepped into without subsequently stepping out.