Struct Document 

pub struct Document { /* private fields */ }

A DOCX document

Implementations

impl Document

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a document from a file path

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Open a document from bytes

pub fn new() -> Self

Create a new empty document

pub fn save<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Save the document to a file

pub fn to_bytes(&mut self) -> Result<Vec<u8>>

Save the document to bytes

pub fn paragraphs(&self) -> impl Iterator<Item = &Paragraph>

Get all paragraphs

pub fn paragraph_count(&self) -> usize

Get paragraph count

pub fn paragraph(&self, index: usize) -> Option<&Paragraph>

Get paragraph by index

pub fn tables(&self) -> impl Iterator<Item = &Table>

Get all tables

pub fn table_count(&self) -> usize

Get table count

pub fn table(&self, index: usize) -> Option<&Table>

Get table by index

pub fn text(&self) -> String

Get all text in the document

pub fn package(&self) -> &Package

Get the underlying package

pub fn body_mut(&mut self) -> &mut Body

Get mutable body

pub fn add_paragraph(&mut self, text: impl Into<String>) -> &mut Paragraph

Add a paragraph with text

pub fn add_empty_paragraph(&mut self) -> &mut Paragraph

Add an empty paragraph

pub fn numbering(&self) -> Option<&Numbering>

Get numbering definitions

pub fn numbering_mut(&mut self) -> Option<&mut Numbering>

Get mutable numbering definitions

pub fn is_list_item(&self, para: &Paragraph) -> bool

Check if a paragraph is a list item

pub fn is_bullet_list_item(&self, para: &Paragraph) -> bool

Check if a paragraph is a bullet list item

pub fn list_level(&self, para: &Paragraph) -> Option<u32>

Get the list level of a paragraph (0-8), or None if not a list item

pub fn list_format(&self, para: &Paragraph) -> Option<&NumberFormat>

Get the number format for a list item

pub fn add_table(&mut self, table: Table) -> &mut Table

Add a table to the document

pub fn add_table_with_size(&mut self, rows: usize, cols: usize) -> &mut Table

Create and add a table with specified rows and columns

pub fn table_mut(&mut self, index: usize) -> Option<&mut Table>

Get mutable table by index

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.