Struct Writer

pub struct Writer<W: Write> {
    pub wtr: BufWriter<W>,
    /* private fields */
}

A writer for a refer file.

It’s a simple wrapper of a io::BufWriter, along with a line number tracker to help track errors when parsing the input.

Fields

wtr: BufWriter<W>

Implementations

impl Writer<File>

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Writer<File>, Error>

Build a refer writer that writes data to the given file path. The file is truncated if it already exists.

If there was a problem opening the file at the given path, then this returns the corresponding error.

Example

use std::error::Error;
use refer::Writer;

fn example() -> Result<(), Box<dyn Error>> {
    let mut wtr = Writer::from_path("foo.refer")?;
    wtr.write_record(vec!["%A Brown, M", "%J PNAS"])?;
    wtr.write_record(vec!["%A Twyford, A. D.", "%J PNAS"])?;
    wtr.flush()?;
    Ok(())
}

impl<W: Write> Writer<W>

pub fn new(wtr: W) -> Writer<W>

Create a new refer writer.

Example

use std::error::Error;
use refer::Writer;

fn example() -> Result<(), Box<dyn Error>> {
    let mut wtr = Writer::new(vec![]);
    wtr.write_record(vec!["%A Brown, M", "%J PNAS"])?;
    wtr.write_record(vec!["%A Twyford, A. D.", "%J PNAS"])?;

    let data = String::from_utf8(wtr.into_inner()?)?;
    assert_eq!(data, "%A Brown, M\n%J PNAS\n\n%A Twyford, A. D.\n%J PNAS\n\n");
    Ok(())
}

pub fn write_record<I, T>(&mut self, record: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: AsRef<[u8]> + Into<Vec<u8>>,

The main function used to write a record to an output buffer.

pub fn into_inner(self) -> StdResult<W, IntoInnerError<BufWriter<W>>>

Flush the contents of the current buffer and return the underlying writer.

pub fn flush(&mut self) -> StdResult<(), Error>

Flush the writer at the end of usage.