Struct pgcopy::Encoder

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

Low-level encoder for binary format.

End users are required to manually call all necessary methods in a right order.

use pgcopy::Encoder;

let mut buf: Vec<u8> = vec![];
let mut encoder = Encoder::new(&mut buf);

encoder.write_header().unwrap();

encoder.write_tuple(3).unwrap(); // First tuple with three columns
encoder.write_smallint(1).unwrap(); // First column
encoder.write_bool(false).unwrap(); // Second
encoder.write_str("first").unwrap(); // Third

encoder.write_tuple(3).unwrap(); // Second tuple
encoder.write_smallint(2).unwrap();
encoder.write_bool(true).unwrap();
encoder.write_str("second").unwrap();

encoder.write_trailer().unwrap();

println!("{:?}", encoder.get_ref());

Methods

impl<W> Encoder<W> where
    W: Write, 

pub fn new(writer: W) -> Encoder<W>

Creates new encoder.

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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

Acquires a mutable reference to the underlying writer.

Note that mutating the output/input state of the stream may corrupt this object, so care must be taken when using this method.

pub fn write_header(&mut self) -> Result<()>

Writes binary format header.

Caller is required to invoke this method first before starting to write tuples data.

pub fn write_trailer(&mut self) -> Result<()>

Writes binary format trailer.

Caller is required to invoke this method last immediately after writing tuples data.

pub fn write_tuple(&mut self, fields: i16) -> Result<()>

Starts a new tuple.

Each tuple begins with a signed 16-bit integer count of the number of fields in the tuple. Presently, all tuples in a table will have the same count.

pub fn write_null(&mut self) -> Result<()>

Writes NULL as a column value.

pub fn write_smallint(&mut self, value: i16) -> Result<()>

Writes smallint type value.

pub fn write_int(&mut self, value: i32) -> Result<()>

Writes int type value.

pub fn write_bigint(&mut self, value: i64) -> Result<()>

Writes bigint type value.

pub fn write_real(&mut self, value: f32) -> Result<()>

Writes real type value.

pub fn write_double(&mut self, value: f64) -> Result<()>

Writes double precision type value.

pub fn write_str<T: AsRef<str>>(&mut self, value: T) -> Result<()>

Writes character type value.

Any of character varying(n), character(n) or text column type should be handled by this method.

pub fn write_bytea<T: AsRef<[u8]>>(&mut self, value: T) -> Result<()>

Writes bytea type value.

pub fn write_timestamp<T: Timestamp>(&mut self, value: T) -> Result<()>

Writes timestamp type value.

See Timestamp type implementors for available options here.

pub fn write_timestamp_with_time_zone<T: TimestampWithTimeZone>(
    &mut self,
    value: T
) -> Result<()>

Writes timestamp with time zone type value.

See TimestampWithTimeZone type implementors for available options here.

pub fn write_date<T: Date>(&mut self, value: T) -> Result<()>

Writes date type value.

See Date type implementors for available options here.

pub fn write_time<T: Time>(&mut self, value: T) -> Result<()>

Writes time type value.

See Time type implementors for available options here.

pub fn write_bool<T: Into<bool>>(&mut self, value: T) -> Result<()>

Writes bool type value.

pub fn write_uuid<T: Uuid>(&mut self, value: T) -> Result<()>

Writes uuid type value.

See Uuid type implementors for available options here.

Trait Implementations

impl<W: Clone + Write> Clone for Encoder<W>

fn clone(&self) -> Encoder<W>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.