Struct Body 

pub struct Body {
    pub block_content: Vec<BlockContent>,
    pub sect_pr: Option<Box<SectionProperties>>,
    pub extra_children: Vec<PositionedNode>,
}

Fields

block_content: Vec<BlockContent>

sect_pr: Option<Box<SectionProperties>>

extra_children: Vec<PositionedNode>

Unknown child elements captured for roundtrip fidelity.

Implementations

impl Body

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

Add an empty paragraph and return a mutable reference to it.

pub fn add_table(&mut self) -> &mut Table

Add an empty table and return a mutable reference to it.

pub fn set_section_properties(&mut self, sect_pr: SectionProperties)

Set section properties on the body.

impl Body

pub fn add_form_field(&mut self, config: FormFieldConfig) -> &mut Self

Add a form field as a Structured Document Tag (<w:sdt>).

Produces a block-level SDT containing an appropriate SDT properties element (<w:sdtPr>) and content paragraph with the default value.

ECMA-376 Part 1, Section 17.5.2.

impl Body

pub fn add_toc(&mut self, opts: TocOptions) -> &mut Self

Insert a Table of Contents field at the current position.

This writes:

1. An optional title paragraph styled “TOC Heading”.
2. A TOC field spanning three paragraphs: fldChar begin, instrText, fldChar end.
3. A placeholder paragraph telling the user to update the field.

ECMA-376 Part 1, Section 17.16.5.58 (TOC).

Trait Implementations

impl BodyExt for Body

fn paragraphs(&self) -> Vec<&Paragraph>

Get all paragraphs in the body.

fn tables(&self) -> Vec<&Table>

Get all tables in the body.

fn text(&self) -> String

Extract all text content from the body.

fn section_properties(&self) -> Option<&SectionProperties>

Get the document-level section properties (layout info).

fn table_of_contents(&self) -> Vec<TableOfContents>

Extract all Tables of Contents from this body.

fn form_fields(&self) -> Vec<FormField>

Extract all form fields from this body (ECMA-376 §17.5.2).

impl BodyRevisionExt for Body

Available on crate feature wml-track-changes only.

fn all_track_changes(&self) -> Vec<TrackChange>

All tracked changes in the document body across all paragraphs.

fn accepted_text(&self) -> String

Full document text with all insertions accepted and deletions removed.

fn rejected_text(&self) -> String

Full document text with all insertions rejected and deletions restored.

impl Clone for Body

fn clone(&self) -> Body

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Body

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Body

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromXml for Body

fn from_xml<R: BufRead>( reader: &mut Reader<R>, start_tag: &BytesStart<'_>, is_empty: bool, ) -> Result<Self, ParseError>

Parse from an XML reader positioned at the start tag.

impl MathExt for Body

Available on crate feature extra-children only.

fn math_expressions(&self) -> Vec<MathExpression>

Return all math expressions contained in this element.

fn has_math(&self) -> bool

Return true if this element contains at least one math expression.

impl Serialize for Body

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToXml for Body

fn write_children<W: Write>( &self, writer: &mut Writer<W>, ) -> Result<(), SerializeError>

Write child elements and text content inside the element.

fn is_empty_element(&self) -> bool

Whether this element has no children (self-closing).

fn write_attrs<'a>(&self, start: BytesStart<'a>) -> BytesStart<'a>

Write attributes onto the start tag and return it.

fn write_element<W>( &self, tag: &str, writer: &mut Writer<W>, ) -> Result<(), SerializeError>

where W: Write,

Write a complete element: <tag attrs>children</tag> or <tag attrs/>.