Struct BookWriter

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

A tool for writing a Book.

A BookWriter creates a new Book.

To write a chapter, call new_chapter().

When the book is complete, call close() to flush any remaining bytes and write out the table of contents.

Implementations

impl<W: Write> BookWriter<W>

pub fn new(writer: W, user_magic: u32) -> Result<Self>

Create a new BookWriter.

user_magic is a number stored in the file for later identification. It can contain any value the user wants, and can be used to disambiguate different kinds of files.

pub fn new_chapter<Id>(self, id: Id) -> ChapterWriter<W>

where Id: Into<ChapterId>,

Create a new ChapterWriter.

The chapter id can be any value the user wants, and can be used to later locate a chapter. It may be any type that implements Into<ChapterId>.

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

Finish writing the Book file.

On success, this returns the original writer stream. It is normal to discard it, except in unit tests.

Trait Implementations

impl<W: Debug> Debug for BookWriter<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.