Struct cbor::Encoder

pub struct Encoder<W> { /* fields omitted */ }

Encodes Rust values to CBOR bytes in the underlying writer W.

Note that currently, using the serialization infrastructure is the only way to write CBOR in this crate.

Methods

impl<W: Write> Encoder<W>

pub fn from_writer(wtr: W) -> Encoder<BufWriter<W>>

Encode CBOR to an arbitrary writer.

pub fn encode<I>(&mut self, it: I) -> CborResult<()> where     I: IntoIterator,     <<I as IntoIterator>::IntoIter as Iterator>::Item: Encodable,

Encode an iterator of Rust values to CBOR in the underlying writer.

Every value in the iterator must satisfy Encodable (from the rustc-serialize crate).

Note that this encodes top-level CBOR data items. They can be decoded in a streaming fashion.

Example

Encode a list of numbers.

use cbor::Encoder;

let mut enc = Encoder::from_memory();
enc.encode(&[1, 2, 3, 4, 5]);
assert_eq!(vec![1, 2, 3, 4, 5], enc.as_bytes());

pub fn flush(&mut self) -> CborResult<()>

Flush the underlying writer.

impl Encoder<Vec<u8>>

pub fn from_memory() -> Encoder<Vec<u8>>

Encode CBOR to an in memory buffer.

pub fn as_bytes(&mut self) -> &[u8]

Flush and retrieve the CBOR bytes that have been written.

pub fn into_bytes(self) -> Vec<u8>

Flush and retrieve the CBOR bytes that have been written without copying.

Trait Implementations

impl<W: Write> RustcEncoder for Encoder<W>

type Error = CborError

The error type for method results.

fn emit_nil(&mut self) -> CborResult<()>

Emit a nil value.

fn emit_usize(&mut self, v: usize) -> CborResult<()>

Emit a usize value.

fn emit_u64(&mut self, v: u64) -> CborResult<()>

Emit a u64 value.

fn emit_u32(&mut self, v: u32) -> CborResult<()>

Emit a u32 value.

fn emit_u16(&mut self, v: u16) -> CborResult<()>

Emit a u16 value.

fn emit_u8(&mut self, v: u8) -> CborResult<()>

Emit a u8 value.

fn emit_isize(&mut self, v: isize) -> CborResult<()>

Emit a isize value.

fn emit_i64(&mut self, v: i64) -> CborResult<()>

Emit a i64 value.

fn emit_i32(&mut self, v: i32) -> CborResult<()>

Emit a i32 value.

fn emit_i16(&mut self, v: i16) -> CborResult<()>

Emit a i16 value.

fn emit_i8(&mut self, v: i8) -> CborResult<()>

Emit a i8 value.

fn emit_f64(&mut self, v: f64) -> CborResult<()>

Emit a f64 value.

fn emit_f32(&mut self, v: f32) -> CborResult<()>

Emit a f32 value.

fn emit_bool(&mut self, v: bool) -> CborResult<()>

Emit a bool value.

fn emit_char(&mut self, v: char) -> CborResult<()>

Emit a char value.

fn emit_str(&mut self, v: &str) -> CborResult<()>

Emit a string value.

fn emit_enum<F>(&mut self, _name: &str, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit an enumeration value.

fn emit_enum_variant<F>(     &mut self,     v_name: &str,     _v_id: usize,     len: usize,     f: F ) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a enumeration variant value with no or unnamed data.

fn emit_enum_variant_arg<F>(&mut self, _idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit an unnamed data item for an enumeration variant.

fn emit_enum_struct_variant<F>(     &mut self,     v_name: &str,     v_id: usize,     len: usize,     f: F ) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a enumeration variant value with no or named data.

fn emit_enum_struct_variant_field<F>(     &mut self,     _f_name: &str,     idx: usize,     f: F ) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a named data item for an enumeration variant.

fn emit_struct<F>(&mut self, name: &str, len: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a struct value.

fn emit_struct_field<F>(     &mut self,     f_name: &str,     _f_idx: usize,     f: F ) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a field item for a struct.

fn emit_tuple<F>(&mut self, len: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a tuple value.

fn emit_tuple_arg<F>(&mut self, idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a data item for a tuple.

fn emit_tuple_struct<F>(     &mut self,     _name: &str,     len: usize,     f: F ) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a tuple struct value.

fn emit_tuple_struct_arg<F>(&mut self, idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a data item for a tuple struct.

fn emit_option<F>(&mut self, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit an optional value.

fn emit_option_none(&mut self) -> CborResult<()>

Emit the None optional value.

fn emit_option_some<F>(&mut self, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit the Some(x) optional value.

fn emit_seq<F>(&mut self, len: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit a sequence of values.

fn emit_seq_elt<F>(&mut self, _idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit an element in a sequence.

fn emit_map<F>(&mut self, len: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit an associative container (map).

fn emit_map_elt_key<F>(&mut self, _idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit the key for an entry in a map.

fn emit_map_elt_val<F>(&mut self, _idx: usize, f: F) -> CborResult<()> where     F: FnOnce(&mut Encoder<W>) -> CborResult<()>,

Emit the value for an entry in a map.