Struct Writer

Source

pub struct Writer { /* private fields */ }

Expand description

Writer for loam files

The writer can be used to create or append to an existing file.

Implementations§

Source §

impl Writer

Source

pub fn new(path: P) -> Result<Self>
where P: AsRef<Path>,

Create a new Writer

Examples found in repository ?

examples/write.rs (line 7)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mut root = node::Node::new("Root");
5    root.push(20);
6    root.push(40);
7    let mut w = loam::Writer::new("test.loam")?;
8    let id = w.push(&root)?;
9    w.checkpoint(id)?;
10    Ok(())
11}

Source

pub fn push<D>(&mut self, data: &D) -> Result<Id>
where D: Serialize,

Push a chunk of data to the end of the file.

§Returns

Id chunk identifier

Examples found in repository ?

examples/write.rs (line 8)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mut root = node::Node::new("Root");
5    root.push(20);
6    root.push(40);
7    let mut w = loam::Writer::new("test.loam")?;
8    let id = w.push(&root)?;
9    w.checkpoint(id)?;
10    Ok(())
11}

Source

pub fn checkpoint(&mut self, id: Id) -> Result<()>

Add a checkpoint to the file. The Id commonly points to the root of a tree of nodes.

In order to be read back, a file must end with a checkpoint.

Examples found in repository ?

examples/write.rs (line 9)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mut root = node::Node::new("Root");
5    root.push(20);
6    root.push(40);
7    let mut w = loam::Writer::new("test.loam")?;
8    let id = w.push(&root)?;
9    w.checkpoint(id)?;
10    Ok(())
11}