Skip to main content

LayoutInput

rdocx_layout::input

Struct LayoutInput

pub struct LayoutInput {Show 18 fields
    pub document: CT_Document,
    pub automatic_hyphenation: bool,
    pub math_properties: Option<MathProperties>,
    pub revision_view: RevisionView,
    pub styles: CT_Styles,
    pub numbering: Option<CT_Numbering>,
    pub headers: HashMap<String, CT_HdrFtr>,
    pub footers: HashMap<String, CT_HdrFtr>,
    pub images: HashMap<String, ImageData>,
    pub charts: HashMap<String, Result<Box<CT_ChartSpace>, String>>,
    pub chart_theme: CT_OfficeStyleSheet,
    pub chart_color_map: ColorMap,
    pub core_properties: Option<CoreProperties>,
    pub hyperlink_urls: HashMap<String, String>,
    pub footnotes: Option<CT_Footnotes>,
    pub endnotes: Option<CT_Footnotes>,
    pub theme: Option<Theme>,
    pub fonts: Vec<FontFile>,
}

Expand description

All inputs needed to lay out a DOCX document.

Fields§

§document: CT_Document

The parsed document content.

§automatic_hyphenation: bool

Whether document settings enable automatic hyphenation.

§math_properties: Option<MathProperties>

Document-wide OfficeMath defaults from the settings part.

§revision_view: RevisionView

The tracked-revision projection to lay out.

§styles: CT_Styles

Style definitions.

§numbering: Option<CT_Numbering>

Numbering definitions (optional).

§headers: HashMap<String, CT_HdrFtr>

Header parts keyed by relationship ID.

§footers: HashMap<String, CT_HdrFtr>

Footer parts keyed by relationship ID.

§images: HashMap<String, ImageData>

Images keyed by embed ID.

§charts: HashMap<String, Result<Box<CT_ChartSpace>, String>>

Parsed chart parts, or contextual relationship failures, keyed by ID.

§chart_theme: CT_OfficeStyleSheet

DrawingML theme used by the shared chart renderer.

§chart_color_map: ColorMap

Standard Word chart colour mapping.

§core_properties: Option<CoreProperties>

Document core properties (metadata).

§hyperlink_urls: HashMap<String, String>

Hyperlink URLs keyed by relationship ID.

§footnotes: Option<CT_Footnotes>

Footnote definitions.

§endnotes: Option<CT_Footnotes>

Endnote definitions.

§theme: Option<Theme>

Document theme (colors + fonts).

§fonts: Vec<FontFile>

User-provided or DOCX-embedded font files. These are loaded before system fonts, so they take priority.

Trait Implementations§

impl Clone for LayoutInput

fn clone(&self) -> LayoutInput

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for LayoutInput

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for LayoutInput

impl RefUnwindSafe for LayoutInput

impl Send for LayoutInput

impl Sync for LayoutInput

impl Unpin for LayoutInput

impl UnsafeUnpin for LayoutInput

impl UnwindSafe for LayoutInput

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.