Struct Encoder 

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

This struct implements an encoder for the frcode format. The encoder writes directly to the underlying Write instance.

To encode an entry you should first call write_meta a number of times to fill the meta data portion. Then, call write_path once to finialize the entry.

One important property of this encoder is that it is safe to open and close it multiple times on the same stream, like this:

{
  let encoder1 = Encoder::new(&mut stream);
} // encoder1 gets dropped here
{
  let encoder2 = Encoder::new(&mut stream);
}

To support this, the encoder has a “footer” item that will get written when it is dropped. This is necessary because we need to write at least one more entry to reset the shared prefix length to zero, since the next encoder will expect that as initial state.

Implementations

impl<W: Write> Encoder<W>

pub fn new(writer: W, footer_meta: Vec<u8>, footer_path: Vec<u8>) -> Encoder<W>

Constructs a new encoder for the specific writer.

The encoder will write the given footer_meta and footer_path as the last entry.

Panics

If either footer_meta or footer_path contain NUL or newline bytes.

pub fn write_meta(&mut self, meta: &[u8]) -> Result<()>

Writes the meta data of an entry to the output stream.

This function can be called multiple times to extend the current meta data part. Since the meta data is written as-is to the output stream, calling the function multiple times will concatenate the meta data of all calls.

Panics

If the meta data contains NUL bytes or newlines.

pub fn write_path(&mut self, path: Vec<u8>) -> Result<()>

Finalizes an entry by encoding its path to the output stream.

This function should be called after you’ve finished writing the meta data for the current entry. It will terminate the meta data part by writing the NUL byte and then encode the path into the output stream.

The entry will be terminated with a newline.

Panics

If the path contains NUL bytes or newlines.

pub fn finish(self) -> Result<()>

Finishes the encoder by writing the footer entry.

This function is called by drop, but calling it explictly is recommended as drop has no way to report IO errors that may occur during writing the footer.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.