Struct Writer 

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

Abstraction layer for writing UTF tables

Implementations

impl<'a> Writer<'a>

pub fn new(table_name: &'a str) -> Writer<'a>

Creates a new Writer

Example

let writer = Writer::new("ImportantTable");

pub fn end( &self, writer: &mut dyn Write, row_size: u16, row_count: u32, ) -> Result<()>

Verifies the amount of data written to the row buffer, and writes the final UTF table to the given stream.

Example

let mut file = File::create("important-table.bin")?;
let writer = Writer::new("ImportantTable");
// ... table writing code ...
writer.end(file, 12, 1000)?:

pub fn push_constant_column<T: Value>( &mut self, name: &'a str, value: &'a T, ) -> Result<()>

Adds a new constant column with the given value

Example

let file_count = 5000u64;
let comment = "This is my comment".to_owned();
{
    let writer = Writer::new("ImportantTable");
    writer.push_constant_column("FileCount", file_count)?;
    writer.push_constant_column::<String>("Comment", &comment)?;
}

pub fn push_constant_column_opt<T: Value>( &mut self, name: &'a str, value: &'a Option<T>, ) -> Result<()>

Adds a new optional constant column with the given value

Example

let crc32: Option<u32> = Some(0);
let writer = Writer::new("ImportantTable");
writer.push_constant_column_opt("Crc", &crc32)?;

pub fn push_rowed_column<T: Value>(&mut self, name: &'a str)

Adds a new rowed column

Example

let writer = Writer::new("ImportantTable");
writer.push_rowed_column::<u64>("ID");

pub fn push_rowed_column_opt<T: Value>(&mut self, name: &'a str, included: bool)

Adds a new optional rowed column

Example

let context = WriteContext::new();
// ...
let writer = Writer::new("ImportantTable");
writer.push_rowed_column_opt::<u64>("ID", context.is_included("ID"));

pub fn write_value<T: Value>(&mut self, rowed: bool, value: &'a T) -> Result<()>

Writes a value directly into the column or row buffer

Example

for row in rows {
    writer.write_value::<u64>(true, &row.id)?;
    writer.write_value(true, &row.name)?;
}