Struct Run

Source
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>>,
}
Expand description

Run

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

use docx_rust::document::*;
use docx_rust::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

Implementations§

Source§

impl<'a> Run<'a>

Source

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

Source

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

Source

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

Source

pub fn push_break<T: Into<Break>>(self, br: T) -> Self

Source

pub fn text(&self) -> String

Source

pub fn iter_text(&self) -> Box<dyn Iterator<Item = &Cow<'a, str>> + '_>

Source

pub fn iter_text_mut( &mut self, ) -> Box<dyn Iterator<Item = &mut Cow<'a, str>> + '_>

Source

pub fn replace_text_simple<S>(&mut self, old: S, new: S)
where S: AsRef<str>,

Source

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

Trait Implementations§

Source§

impl<'a> Clone for Run<'a>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Run<'a>

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for Run<'a>

§

impl<'a> RefUnwindSafe for Run<'a>

§

impl<'a> Send for Run<'a>

§

impl<'a> Sync for Run<'a>

§

impl<'a> Unpin for Run<'a>

§

impl<'a> UnwindSafe for Run<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> XmlReadOwned for T
where T: for<'s> XmlRead<'s>,