Struct bookfile::ChapterWriter

pub struct ChapterWriter<W> { /* fields omitted */ }

A tool for writing a Chapter.

A ChapterWriter creates a new chapter. Chapters will be written sequentially in the file, and only one can be active at a time.

To write the chapter data, use the Write interface.

When the chapter is complete, call close() to flush any remaining bytes and update the Book table-of-contents.

Attempting to drop a chapter without calling close will cause a panic.

See BookWriter for more information.

Implementations

impl<W> ChapterWriter<W> where
    W: Write, 

pub fn close(self) -> Result<BookWriter<W>>

Complete the chapter.

This will return the original BookWriter after updating its TOC.

Chapter instances should not be dropped; they must be consumed by calling close. This allows us to detect any final IO errors and update the TOC.

Trait Implementations

impl<W> Drop for ChapterWriter<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Write for ChapterWriter<W> where
    W: Write, 

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

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

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

Flush 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, fmt: Arguments<'_>) -> Result<(), Error>

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

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

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