DocumentFragment

Struct DocumentFragment 

Source
pub struct DocumentFragment<ChildType: VirtualNode> {
    pub children: Vec<ChildType>,
    pub classes: ClassList,
    pub height: f64,
    pub depth: f64,
    pub max_font_size: f64,
    pub style: CssStyle,
}
Expand description

Document fragment containing elements without DOM representation

Fields§

§children: Vec<ChildType>

The child nodes contained within this document fragment. These represent the nested elements in the virtual DOM tree structure used for mathematical rendering in KaTeX. Each child is a VirtualNode that can be rendered into HTML or MathML markup.

§See Also

§classes: ClassList

CSS class names applied to this document fragment. These classes control styling and layout in the rendered mathematical output, following KaTeX’s CSS conventions.

§See Also

§height: f64

The height of this document fragment in em units, representing the vertical extent above the baseline in mathematical rendering. Used for proper alignment and spacing in LaTeX expressions.

§Mathematical Context

In KaTeX, height is crucial for aligning superscripts, fractions, and other vertical elements.

§depth: f64

The depth of this document fragment in em units, representing the vertical extent below the baseline in mathematical rendering. Used for proper alignment and spacing in LaTeX expressions.

§Mathematical Context

In KaTeX, depth is crucial for aligning subscripts, fractions, and other vertical elements.

§max_font_size: f64

The maximum font size used within this document fragment, in points. This value determines the scaling factor for the entire fragment in mathematical rendering.

§See Also

  • Font metrics in KaTeX for size calculations
§style: CssStyle

Inline CSS styles applied to this document fragment. These styles override default KaTeX styling and allow for custom rendering adjustments in mathematical expressions.

§See Also

  • CssStyle: The type used for style properties
  • KaTeX CSS documentation for available style properties

Implementations§

Source§

impl<ChildType: VirtualNode> DocumentFragment<ChildType>

Source

pub fn new(children: Vec<ChildType>) -> Self

Create a new document fragment with the given children

Source

pub fn has_class(&self, class_name: &str) -> bool

Check if the fragment has a specific class

Trait Implementations§

Source§

impl<ChildType: VirtualNode + Clone> Clone for DocumentFragment<ChildType>

Source§

fn clone(&self) -> Self

Returns a duplicate 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<ChildType: Debug + VirtualNode> Debug for DocumentFragment<ChildType>

Source§

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

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

impl From<DocumentFragment<HtmlDomNode>> for HtmlDomNode

Source§

fn from(fragment: HtmlDomFragment) -> Self

Converts to this type from the input type.
Source§

impl From<DocumentFragment<MathDomNode>> for MathDomNode

Source§

fn from(fragment: MathDomFragment) -> Self

Converts to this type from the input type.
Source§

impl<ChildType: VirtualNode + Clone + 'static> VirtualNode for DocumentFragment<ChildType>

Source§

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

Convert into HTML markup by writing into the provided formatter.
Source§

fn to_markup(&self) -> Result<String, ParseError>
where Self: Sized,

Convenience helper that renders the node into a String.

Auto Trait Implementations§

§

impl<ChildType> Freeze for DocumentFragment<ChildType>

§

impl<ChildType> RefUnwindSafe for DocumentFragment<ChildType>
where ChildType: RefUnwindSafe,

§

impl<ChildType> Send for DocumentFragment<ChildType>
where ChildType: Send,

§

impl<ChildType> Sync for DocumentFragment<ChildType>
where ChildType: Sync,

§

impl<ChildType> Unpin for DocumentFragment<ChildType>
where ChildType: Unpin,

§

impl<ChildType> UnwindSafe for DocumentFragment<ChildType>
where ChildType: UnwindSafe,

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.