Struct bookfile::BookWriter [−][src]
pub struct BookWriter<W> { /* fields omitted */ }
Expand description
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
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>ⓘNotable traits for ChapterWriter<W>
impl<W> Write for ChapterWriter<W> where
W: Write,
where
Id: Into<ChapterId>,
pub fn new_chapter<Id>(self, id: Id) -> ChapterWriter<W>ⓘNotable traits for ChapterWriter<W>
impl<W> Write for ChapterWriter<W> where
W: Write,
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>
.
Trait Implementations
Auto Trait Implementations
impl<W> RefUnwindSafe for BookWriter<W> where
W: RefUnwindSafe,
impl<W> Send for BookWriter<W> where
W: Send,
impl<W> Sync for BookWriter<W> where
W: Sync,
impl<W> Unpin for BookWriter<W> where
W: Unpin,
impl<W> UnwindSafe for BookWriter<W> where
W: UnwindSafe,