Struct docx_rust::document::Run

pub struct Run<'a> {
    pub rsid_r: Option<Cow<'a, str>>,
    pub rsid_r_default: Option<Cow<'a, str>>,
    pub property: Option<CharacterProperty<'a>>,
    pub content: Vec<RunContent<'a>>,
    pub shall_destroy: Option<bool>,
}

Run

Run is a non-block region of text with properties.

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

let run = Run::default()
    .property(CharacterProperty::default())
    .push_text("text")
    .push_break(None)
    .push_text((" text ", TextSpace::Preserve))
    .push_break(BreakType::Column);

Fields

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

Specifies the properties of a run

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

property: Option<CharacterProperty<'a>>

Just as paragraph, a run’s properties is applied to all the contents of the run.

content: Vec<RunContent<'a>>

Specifies the content of a run

shall_destroy: Option<bool>

Implementations

impl<'a> Run<'a>

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

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

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

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

pub fn push_break<T: Into<Break>>(self, br: 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_simple<S>(&mut self, old: S, new: S) where
    S: AsRef<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 Run<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Run<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Run<'a>

fn default() -> Run<'a>

Returns the “default value” for a type.

impl<'a> From<Run<'a>> for ParagraphContent<'a>

fn from(original: Run<'a>) -> ParagraphContent<'a>

Converts to this type from the input type.

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

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

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

impl<'a> XmlWrite for Run<'a>

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

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