Struct ContentBuilder 

pub struct ContentBuilder {
    pub id: String,
    /* private fields */
}

Content Builder

A builder for constructing EPUB content documents with various block types. This builder manages the creation and organization of content blocks including text, quotes, headings, images, audio, video, and MathML content.

This builder can add simple interface styles via StyleOption or modify document styles by manually write css files.

Fields

id: String

The unique identifier for the content document

This identifier is used to uniquely identify the content document within the EPUB container. If the identifier is not unique, only one content document will be included in the EPUB container; and the other content document will be ignored.

Implementations

impl ContentBuilder

pub fn new(id: &str, language: &str) -> Result<Self, EpubError>

Creates a new ContentBuilder instance

Initializes a ContentBuilder with the specified language code. A temporary directory is automatically created to store media files during construction.

Parameters

• language: The language code for the document

pub fn set_title(&mut self, title: &str) -> &mut Self

Sets the title displayed in the document’s head section.

pub fn set_styles(&mut self, styles: StyleOptions) -> &mut Self

Sets the styles for the document

pub fn add_css_file( &mut self, css_path: PathBuf, ) -> Result<&mut Self, EpubError>

Adds a CSS file to the document

Copies the CSS file to a temporary directory for inclusion in the EPUB package. The CSS file will be linked in the document’s head section when generating the output.

Parameters

• css_path: The path to the CSS file to add

Return

• Ok(&mut self): If the file exists and is accessible
• Err(EpubError): If the file does not exist or is not accessible

pub fn add_block(&mut self, block: Block) -> Result<&mut Self, EpubError>

Adds a block to the document

Adds a constructed Block to the document.

Parameters

• block: The Block to add to the document

pub fn add_text_block( &mut self, content: &str, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds a text block to the document

Convenience method that creates and adds a Text block using the provided content and footnotes.

Parameters

• content: The text content of the paragraph
• footnotes: A vector of footnotes associated with the text

pub fn add_quote_block( &mut self, content: &str, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds a quote block to the document

Convenience method that creates and adds a Quote block using the provided content and footnotes.

Parameters

• content: The quoted text
• footnotes: A vector of footnotes associated with the quote

pub fn add_title_block( &mut self, content: &str, level: usize, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds a heading block to the document

Convenience method that creates and adds a Title block with the specified level.

Parameters

• content: The heading text
• level: The heading level (1-6), corresponding to h1-h6 HTML tags
• footnotes: A vector of footnotes associated with the heading

pub fn add_image_block( &mut self, url: PathBuf, alt: Option<String>, caption: Option<String>, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds an image block to the document

Convenience method that creates and adds an Image block with optional alt text, caption, and footnotes.

Parameters

• url: The path to the image file
• alt: Optional alternative text for the image (displayed when image cannot load)
• caption: Optional caption text to display below the image
• footnotes: A vector of footnotes associated with the caption or image

pub fn add_audio_block( &mut self, url: PathBuf, fallback: String, caption: Option<String>, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds an audio block to the document

Convenience method that creates and adds an Audio block with fallback text, optional caption, and footnotes.

Parameters

• url: The path to the audio file
• fallback: Fallback text displayed when the audio cannot be played
• caption: Optional caption text to display below the audio player
• footnotes: A vector of footnotes associated with the caption or audio

pub fn add_video_block( &mut self, url: PathBuf, fallback: String, caption: Option<String>, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds a video block to the document

Convenience method that creates and adds a Video block with fallback text, optional caption, and footnotes.

Parameters

• url: The path to the video file
• fallback: Fallback text displayed when the video cannot be played
• caption: Optional caption text to display below the video player
• footnotes: A vector of footnotes associated with the caption or video

pub fn add_mathml_block( &mut self, element_str: String, fallback_image: Option<PathBuf>, caption: Option<String>, footnotes: Vec<Footnote>, ) -> Result<&mut Self, EpubError>

Adds a MathML block to the document

Convenience method that creates and adds a MathML block with optional fallback image, caption, and footnotes.

Parameters

• element_str: The raw MathML markup string
• fallback_image: Optional path to a fallback image displayed when MathML cannot render
• caption: Optional caption text to display below the MathML element
• footnotes: A vector of footnotes associated with the caption or equation

pub fn make<P: AsRef<Path>>( &mut self, target: P, ) -> Result<Vec<PathBuf>, EpubError>

Builds content document

The final constructed content document has the following structure:

<body>
    <main>
        <!-- The specific block structure can be queried in the Block docs. -->
    </main>
    <aside>
        <ul class="footnote-list">
            <!-- Each footnote has the same structure. -->
            <li class="footnote-item" id="footnote-{{ index }}">
                <p>
                    <a herf="ref-{{ index }}">[{{ index }}]</a>
                    {{ footnote.content }}
                </p>
            </li>
        </ul>
    </aside>
</body>

Parameters

• target: The file path where the document should be written

Return

• Ok(Vec<PathBuf>): A vector of paths to all resources used in the document
• Err(EpubError): Error occurred during the making process

Trait Implementations

impl Debug for ContentBuilder

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

Formats the value using the given formatter.

impl Drop for ContentBuilder

fn drop(&mut self)

Executes the destructor for this type.