Struct BenEncoder 

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

A struct to make the writing of BEN files easier and more ergonomic.

Example

use ben::{encode::BenEncoder, BenVariant};

let mut buffer = Vec::new();
let mut ben_encoder = BenEncoder::new(&mut buffer, BenVariant::Standard);

ben_encoder.write_assignment(vec![1, 1, 1, 2, 2, 2]);

Implementations

impl<W: Write> BenEncoder<W>

pub fn new(writer: W, variant: BenVariant) -> Self

Create a new BenEncoder instance and handles the BEN file header.

Arguments

• writer - A writer to write the BEN file to
• variant - The BEN variant to use (Standard or MkvChain)

Returns

A new BenEncoder instance

pub fn write_rle(&mut self, rle_vec: Vec<(u16, u16)>) -> Result<()>

Write a run-length encoded assignment vector to the BEN file.

Arguments

• rle_vec - A run-length encoded assignment vector to write

Returns

A Result type that contains the result of the operation

pub fn write_assignment(&mut self, assign_vec: Vec<u16>) -> Result<()>

Write an assignment vector to the BEN file.

Arguments

• assign_vec - An assignment vector to write

Returns

A Result type that contains the result of the operation

pub fn write_json_value(&mut self, data: Value) -> Result<()>

Write a JSON value containing an assignment vector to the BEN file.

Arguments

• data - A JSON value containing an assignment vector

Returns

A Result type that contains the result of the operation

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

Cleanup function to make sure the last sample is written to the BEN file if using the MkvChain variant.

This function is automatically called when the BenEncoder goes out of scope, but can be called manually if desired.

Returns

A Result type that contains the result of the operation

Errors

This function will return an error if the writer encounters an error while writing the last sample to the BEN file.

Trait Implementations

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

fn drop(&mut self)

Make sure to finish writing the BEN file when the BenEncoder goes out of scope.