Struct warc::WarcWriter

pub struct WarcWriter<W> { /* private fields */ }

A writer which writes records to an output stream.

Implementations

impl<W: Write> WarcWriter<W>

pub fn new(w: W) -> Self

Create a new writer.

pub fn write(&mut self, record: &Record<BufferedBody>) -> Result<usize>

Write a single record.

The number of bytes written is returned upon success.

pub fn write_raw<B>(
    &mut self,
    headers: RawRecordHeader,
    body: &B
) -> Result<usize> where
    B: AsRef<[u8]>, 

Write a single raw record.

The number of bytes written is returned upon success.

impl<W: Write> WarcWriter<BufWriter<W>>

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

Consume this writer and return the inner writer.

Flushing Compressed Data Streams

This method is necessary to be called at the end of a GZIP-compressed stream. An extra call is needed to flush the buffer of data, and write a trailer to the output stream.

let gzip_stream = writer.into_inner()?;
gzip_writer.finish().into_result()?;

impl WarcWriter<BufWriter<File>>

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Create a new writer which writes to a file.

impl WarcWriter<BufWriter<GzipWriter<File>>>

pub fn from_path_gzip<P: AsRef<Path>>(path: P) -> Result<Self>

Create a new writer which writes to a GZIP-compressed file.