Struct Encoder 

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

WARC format writer

Implementations

impl<S, W: Write> Encoder<S, W>

pub fn get_ref(&self) -> &W

pub fn get_mut(&mut self) -> &mut W

impl<W: Write> Encoder<EncStateHeader, W>

pub fn new(dest: W, config: EncoderConfig) -> Self

Create a new encoder.

The destination writer should not be a compression stream. To enable compression, you must configure it with EncoderConfig.

pub fn write_header( self, header: &WarcHeader, ) -> Result<Encoder<EncStateBlock, W>, GeneralError>

Start a new WARC record with a given header.

The validation function will be called on the header before writing it to the stream.

Consumes the writer and returns a writer that has typestate transitioned to writing the WARC block portion of the record.

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

Flushes any buffered data and returns the underlying stream.

You must call this function before dropping the struct in order to have a valid WARC file.

impl<W: Write> Encoder<EncStateBlock, W>

pub fn finish_block(self) -> Result<Encoder<EncStateHeader, W>>

Indicate writing the block portion of a WARC record has completed.

Consumes the writer and returns a typestate transitioned writer for writing a new record.

Trait Implementations

impl<W: Write> Write for Encoder<EncStateBlock, W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.