Struct Run 

pub struct Run {
    pub rsid_r_pr: Option<STLongHexNumber>,
    pub rsid_del: Option<STLongHexNumber>,
    pub rsid_r: Option<STLongHexNumber>,
    pub r_pr: Option<Box<RunProperties>>,
    pub run_content: Vec<RunContent>,
    pub extra_attrs: HashMap<String, String>,
    pub extra_children: Vec<PositionedNode>,
}

Fields

rsid_r_pr: Option<STLongHexNumber>

rsid_del: Option<STLongHexNumber>

rsid_r: Option<STLongHexNumber>

r_pr: Option<Box<RunProperties>>

run_content: Vec<RunContent>

extra_attrs: HashMap<String, String>

Unknown attributes captured for roundtrip fidelity.

extra_children: Vec<PositionedNode>

Unknown child elements captured for roundtrip fidelity.

Implementations

impl Run

pub fn set_text(&mut self, text: impl Into<String>)

Set the text content of this run.

pub fn set_bold(&mut self, bold: bool)

Set bold on this run. Requires wml-styling feature.

pub fn set_italic(&mut self, italic: bool)

Set italic on this run. Requires wml-styling feature.

pub fn set_page_break(&mut self)

Add a page break to this run.

pub fn set_color(&mut self, hex: &str)

Set the text color on this run (hex string, e.g. “FF0000” for red).

pub fn set_font_size(&mut self, half_points: i64)

Set the font size in half-points (e.g. 48 = 24pt).

pub fn set_strikethrough(&mut self, strike: bool)

Set strikethrough on this run.

pub fn set_underline(&mut self, style: STUnderline)

Set underline style on this run.

pub fn set_fonts(&mut self, fonts: Fonts)

Set fonts on this run.

pub fn set_properties(&mut self, props: RunProperties)

Set run properties.

pub fn add_drawing(&mut self, drawing: CTDrawing)

Add a drawing to this run’s inner content.

pub fn add_footnote_ref(&mut self, id: i64)

Add a footnote reference to this run.

pub fn add_endnote_ref(&mut self, id: i64)

Add an endnote reference to this run.

pub fn add_comment_ref(&mut self, id: i64)

Add a comment reference to this run.

pub fn set_shadow(&mut self, on: bool)

Set shadow effect on this run.

Maps to <w:shadow/> in run properties. ECMA-376 Part 1, Section 17.3.2.31 (w:shadow).

pub fn set_outline(&mut self, on: bool)

Set outline (hollow) text effect on this run.

Maps to <w:outline/> in run properties. ECMA-376 Part 1, Section 17.3.2.23 (w:outline).

pub fn set_emboss(&mut self, on: bool)

Set emboss effect on this run.

Maps to <w:emboss/> in run properties. ECMA-376 Part 1, Section 17.3.2.13 (w:emboss).

pub fn set_imprint(&mut self, on: bool)

Set imprint (engrave) effect on this run.

Maps to <w:imprint/> in run properties. ECMA-376 Part 1, Section 17.3.2.18 (w:imprint).

pub fn set_small_caps(&mut self, on: bool)

Set small caps on this run.

Maps to <w:smallCaps/> in run properties. ECMA-376 Part 1, Section 17.3.2.33 (w:smallCaps).

pub fn set_all_caps(&mut self, on: bool)

Set all caps on this run.

Maps to <w:caps/> in run properties. ECMA-376 Part 1, Section 17.3.2.5 (w:caps).

pub fn set_vanish(&mut self, on: bool)

Set hidden text (vanish) on this run.

Maps to <w:vanish/> in run properties. Hidden text is not rendered unless the application is set to show hidden text. ECMA-376 Part 1, Section 17.3.2.41 (w:vanish).

pub fn set_double_strike(&mut self, on: bool)

Set double strikethrough on this run.

Maps to <w:dstrike/> in run properties. ECMA-376 Part 1, Section 17.3.2.9 (w:dstrike).

Trait Implementations

impl Clone for Run

fn clone(&self) -> Run

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Run

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

Formats the value using the given formatter.

impl Default for Run

fn default() -> Run

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Run

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromXml for Run

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 RunExt for Run

fn text(&self) -> String

Extract text from this run.

fn properties(&self) -> Option<&RunProperties>

Get run properties.

fn has_page_break(&self) -> bool

Check if this run contains a page break.

fn drawings(&self) -> Vec<&CTDrawing>

Get all drawings in this run.

fn is_bold(&self) -> bool

Convenience: check if bold (delegates to properties).

fn is_italic(&self) -> bool

Convenience: check if italic (delegates to properties).

fn is_underline(&self) -> bool

Convenience: check if underlined (delegates to properties).

fn is_strikethrough(&self) -> bool

Convenience: check if strikethrough (delegates to properties).

fn has_images(&self) -> bool

Check if this run contains any drawing elements (images).

fn footnote_ref(&self) -> Option<&FootnoteEndnoteRef>

Get the footnote reference in this run, if any.

fn endnote_ref(&self) -> Option<&FootnoteEndnoteRef>

Get the endnote reference in this run, if any.

impl RunResolveExt for Run

Available on crate feature wml-styling only.

fn resolved_is_bold(&self, ctx: &StyleContext) -> bool

Resolve bold through direct → style chain → defaults.

fn resolved_is_italic(&self, ctx: &StyleContext) -> bool

Resolve italic through direct → style chain → defaults.

fn resolved_font_size_half_points(&self, ctx: &StyleContext) -> Option<u32>

Resolve font size in half-points through direct → style chain → defaults.

fn resolved_font_ascii(&self, ctx: &StyleContext) -> Option<String>

Resolve ASCII font name through direct → style chain → defaults.

fn resolved_color_hex(&self, ctx: &StyleContext) -> Option<String>

Resolve text color hex through direct → style chain → defaults.

fn resolved_is_underline(&self, ctx: &StyleContext) -> bool

Resolve underline through direct → style chain → defaults.

fn resolved_is_strikethrough(&self, ctx: &StyleContext) -> bool

Resolve single strikethrough through direct → style chain → defaults.

fn resolved_is_double_strikethrough(&self, ctx: &StyleContext) -> bool

Resolve double strikethrough through direct → style chain → defaults.

fn resolved_is_all_caps(&self, ctx: &StyleContext) -> bool

Resolve all-caps through direct → style chain → defaults.

fn resolved_is_small_caps(&self, ctx: &StyleContext) -> bool

Resolve small-caps through direct → style chain → defaults.

fn resolved_is_hidden(&self, ctx: &StyleContext) -> bool

Resolve hidden (<w:vanish>) through direct → style chain → defaults.

fn resolved_highlight_color( &self, ctx: &StyleContext, ) -> Option<STHighlightColor>

Resolve highlight color through direct → style chain → defaults.

fn resolved_vertical_alignment( &self, ctx: &StyleContext, ) -> Option<STVerticalAlignRun>

Resolve vertical alignment through direct → style chain → defaults.

impl Serialize for Run

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 Run

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

Write attributes onto the start tag and return it.

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_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/>.