Struct docx_rust::document::Paragraph

pub struct Paragraph<'a> {
    pub rsid_r: Option<Cow<'a, str>>,
    pub rsid_r_default: Option<Cow<'a, str>>,
    pub property: Option<ParagraphProperty<'a>>,
    pub content: Vec<ParagraphContent<'a>>,
    pub shall_destroy: Option<bool>,
}

Paragraph

Paragraph is the main block-level container for content.

use docx::document::*;
use docx::formatting::*;

let par = Paragraph::default()
    .property(ParagraphProperty::default())
    .push_text("hello,")
    .push_text((" world.", TextSpace::Preserve))
    .push(Run::default())
    .push(BookmarkStart::default())
    .push(BookmarkEnd::default());

Fields

rsid_r: Option<Cow<'a, str>>

rsid_r_default: Option<Cow<'a, str>>

property: Option<ParagraphProperty<'a>>

Specifies the properties of a paragraph

This information is applied to all the contents of the paragraph.

content: Vec<ParagraphContent<'a>>

Specifes the run contents of a paragraph

Run is a region of text with properties. Each paragraph containes one or more runs.

shall_destroy: Option<bool>

Implementations

impl<'a> Paragraph<'a>

pub fn property<T: Into<ParagraphProperty<'a>>>(self, value: T) -> Self

pub fn shall_destroy<T: Into<bool>>(self, value: T) -> Self

pub fn push<T: Into<ParagraphContent<'a>>>(self, content: T) -> Self

pub fn push_text<T: Into<Text<'a>>>(self, content: T) -> Self

pub fn iter_text(&self) -> impl Iterator<Item = &Cow<'a, str>>

pub fn iter_text_mut(&mut self) -> impl Iterator<Item = &mut Cow<'a, str>>

pub fn replace_text<'b, T, S>(&mut self, dic: T) -> DocxResult<()> where
    S: AsRef<str> + 'b,
    T: IntoIterator<Item = &'b (S, S)> + Copy, 

Trait Implementations

impl<'a> Clone for Paragraph<'a>

fn clone(&self) -> Paragraph<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Paragraph<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Paragraph<'a>

fn default() -> Paragraph<'a>

Returns the “default value” for a type.

impl<'a> From<Paragraph<'a>> for BodyContent<'a>

fn from(original: Paragraph<'a>) -> BodyContent<'a>

Converts to this type from the input type.

impl<'a> From<Paragraph<'a>> for TableCellContent<'a>

fn from(original: Paragraph<'a>) -> TableCellContent<'a>

Converts to this type from the input type.

impl<'__input: 'a, 'a> XmlRead<'__input> for Paragraph<'a>

fn from_reader(reader: &mut XmlReader<'__input>) -> XmlResult<Self>

fn from_str(text: &'a str) -> Result<Self, XmlError>

impl<'a> XmlWrite for Paragraph<'a>

fn to_writer<W: Write>(&self, writer: &mut XmlWriter<W>) -> XmlResult<()>

fn to_string(&self) -> Result<String, XmlError>