Trait ion_rs::IonWriter

source · 
pub trait IonWriter {
    type Output;


Show 24 methods    // Required methods
    fn ion_version(&self) -> (u8, u8);
    fn write_ion_version_marker(
        &mut self,
        major: u8,
        minor: u8
    ) -> IonResult<()>;
    fn supports_text_symbol_tokens(&self) -> bool;
    fn set_annotations<I, A>(&mut self, annotations: I)
       where A: AsRawSymbolTokenRef,
             I: IntoIterator<Item = A>;
    fn write_null(&mut self, ion_type: IonType) -> IonResult<()>;
    fn write_bool(&mut self, value: bool) -> IonResult<()>;
    fn write_i64(&mut self, value: i64) -> IonResult<()>;
    fn write_int(&mut self, value: &Int) -> IonResult<()>;
    fn write_f32(&mut self, value: f32) -> IonResult<()>;
    fn write_f64(&mut self, value: f64) -> IonResult<()>;
    fn write_decimal(&mut self, value: &Decimal) -> IonResult<()>;
    fn write_timestamp(&mut self, value: &Timestamp) -> IonResult<()>;
    fn write_symbol<A: AsRawSymbolTokenRef>(
        &mut self,
        value: A
    ) -> IonResult<()>;
    fn write_string<A: AsRef<str>>(&mut self, value: A) -> IonResult<()>;
    fn write_clob<A: AsRef<[u8]>>(&mut self, value: A) -> IonResult<()>;
    fn write_blob<A: AsRef<[u8]>>(&mut self, value: A) -> IonResult<()>;
    fn step_in(&mut self, container_type: IonType) -> IonResult<()>;
    fn set_field_name<A: AsRawSymbolTokenRef>(&mut self, name: A);
    fn parent_type(&self) -> Option<IonType>;
    fn depth(&self) -> usize;
    fn step_out(&mut self) -> IonResult<()>;
    fn flush(&mut self) -> IonResult<()>;
    fn output(&self) -> &Self::Output;
    fn output_mut(&mut self) -> &mut Self::Output;

}
Expand description

This trait captures the format-agnostic encoding functionality needed to write native Rust types to a stream as Ion values.

Required Associated Types§

source

type Output

The type to which the implementor writes its data. This may be a file, a buffer, etc.

Required Methods§

source

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.

source

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

Writes an Ion version marker to the output stream.

source

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.

If this method returns false, passing a crate::RawSymbolToken::Text to the Self::set_annotations, Self::set_field_name, or Self::write_symbol methods may result in a panic.

source

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.

source

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

Writes an Ion null with the specified type to the output stream. To write an untyped null (which is equivalent to null.null), pass IonType::Null.

source

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

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

source

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

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

source

fn write_int(&mut self, value: &Int) -> IonResult<()>

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

Starts a new Ion container with the specified type. The only valid IonType values are:

source

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.

source

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.

source

fn depth(&self) -> usize

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

source

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

Ends the current container. If the writer is not currently positioned within a container, calling this method will result in an Err.

source

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

Causes any buffered data to be written to the underlying io::Write implementation. This method can only be called when the writer is at the top level.

source

fn output(&self) -> &Self::Output

Returns a reference to the writer’s output.

This method can be used to inspect the Ion data that the writer has produced without having to first drop the writer.

use ion_rs::element::Element;
use ion_rs::{IonResult, IonWriter, TextWriter, TextWriterBuilder};
// Set up our output buffer
let mut buffer: Vec<u8> = Vec::new();
// Construct a writer that will serialize values to the buffer
let mut writer = TextWriterBuilder::default().build(&mut buffer)?;
// Serialize some data
writer.write_string("hello")?;
writer.flush()?;
// Read the data back from the output buffer
let output_element = Element::read_one(writer.output())?;
// Confirm that it matches the input data
assert_eq!(Element::from("hello"), output_element);
source

fn output_mut(&mut self) -> &mut Self::Output

Returns a mutable reference to the writer’s output.

Modifying the underlying sink is an inherently risky operation and can result in unexpected behavior or invalid data. It is not recommended for most use cases.

Implementors§