Skip to main content

HNode

Enum HNode 

Source
pub enum HNode<ET: EngineTypes> {
Show 19 variants Penalty(i32), Mark(usize, TokenList<ET::Token>), Whatsit(WhatsitNode<ET>), HSkip(Skip<ET::Dim>), HFil, HFill, HFilneg, Hss, Space, HKern(ET::Dim), Leaders(Leaders<ET>), Box(TeXBox<ET>), VRule { width: Option<ET::Dim>, height: Option<ET::Dim>, depth: Option<ET::Dim>, start: SourceRef<ET>, end: SourceRef<ET>, }, Insert(usize, Box<[VNode<ET>]>), VAdjust(Box<[VNode<ET>]>), MathGroup(MathGroup<ET>), Char { char: ET::Char, font: <ET::FontSystem as FontSystem>::Font, }, Accent { accent: ET::Char, char: ET::Char, font: <ET::FontSystem as FontSystem>::Font, }, Custom(ET::CustomNode),
}
Expand description

A horizontal list node.

Variants§

§

Penalty(i32)

A penalty node, as produced by \penalty.

§

Mark(usize, TokenList<ET::Token>)

A mark node, as produced by \mark.

§

Whatsit(WhatsitNode<ET>)

A whatsit node, as produced by \special, \write, etc.

§

HSkip(Skip<ET::Dim>)

A glue node, as produced by \hskip.

§

HFil

A glue node, as produced by \hfil.

§

HFill

A glue node, as produced by \hfill.

§

HFilneg

A glue node, as produced by \hfilneg.

§

Hss

A glue node, as produced by \hss.

§

Space

A glue node, as produced by a space character.

§

HKern(ET::Dim)

A kern node, as produced by \kern.

§

Leaders(Leaders<ET>)

Leaders, as produced by \leaders or \cleaders or \xleaders.

§

Box(TeXBox<ET>)

A box node, as produced by \hbox, \vbox, \vtop, etc.

§

VRule

A rule node, as produced by \vrule.

Fields

§width: Option<ET::Dim>

The provided width of the rule.

§height: Option<ET::Dim>

The provided height of the rule.

§depth: Option<ET::Dim>

The provided depth of the rule.

§start: SourceRef<ET>

The source reference for the start of the rule.

§end: SourceRef<ET>

The source reference for the end of the rule.

§

Insert(usize, Box<[VNode<ET>]>)

An insertion node, as produced by \insert.

§

VAdjust(Box<[VNode<ET>]>)

A vadjust node, as produced by \vadjust; its contents will migrate to the surrounding vertical list eventually.

§

MathGroup(MathGroup<ET>)

A math list, as produced by $...$ or $$...$$.

§

Char

A character node, as produced by a character.

Fields

§char: ET::Char

The character.

§font: <ET::FontSystem as FontSystem>::Font

The current font

§

Accent

An \accent node.

Fields

§accent: ET::Char

The accent character.

§char: ET::Char

The lower character.

§font: <ET::FontSystem as FontSystem>::Font

The current font

§

Custom(ET::CustomNode)

A custom node.

Trait Implementations§

Source§

impl<ET: Clone + EngineTypes> Clone for HNode<ET>
where ET::Token: Clone, ET::Dim: Clone, ET::Char: Clone, ET::FontSystem: Clone, ET::CustomNode: Clone,

Source§

fn clone(&self) -> HNode<ET>

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<ET: Debug + EngineTypes> Debug for HNode<ET>
where ET::Token: Debug, ET::Dim: Debug, ET::Char: Debug, ET::FontSystem: Debug, ET::CustomNode: Debug,

Source§

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

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

impl<ET: EngineTypes> NodeTrait<ET> for HNode<ET>

Source§

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

Produces a human-readable string; since nodes are deeply nested, takes an additional indent value to indent the string
Source§

fn height(&self) -> ET::Dim

Returns the height of the node.
Source§

fn width(&self) -> ET::Dim

Returns the width of the node.
Source§

fn depth(&self) -> ET::Dim

Returns the depth of the node.
Source§

fn nodetype(&self) -> NodeType

Returns the type of the node, as returned by \lastnodetype.
Source§

fn opaque(&self) -> bool

Whether this node is “opaque”; meaning: When considering a list of nodes (e.g. in \unskip or \lastbox, this node should not be considered. Useful for annotation/marker nodes some engine wants to insert, without impacting algorithms that inspect e.g. the last node of the current list.
Source§

fn sourceref(&self) -> Option<(&SourceRef<ET>, &SourceRef<ET>)>

Source§

fn display(&self) -> DisplayNode<'_, ET, Self>

Returns a helper struct that implements Display and uses Self::display_fmt to yield a human-readable string.

Auto Trait Implementations§

§

impl<ET> !Freeze for HNode<ET>

§

impl<ET> !RefUnwindSafe for HNode<ET>

§

impl<ET> Send for HNode<ET>
where <ET as EngineTypes>::Dim: Send, <ET as EngineTypes>::Char: Send, <ET as EngineTypes>::Font: Send, <ET as EngineTypes>::CustomNode: Send, <<ET as EngineTypes>::File as File>::SourceRefID: Send, <ET as EngineTypes>::MuDim: Send, ET: Send,

§

impl<ET> !Sync for HNode<ET>

§

impl<ET> Unpin for HNode<ET>
where <ET as EngineTypes>::Dim: Unpin, <ET as EngineTypes>::Char: Unpin, <ET as EngineTypes>::Font: Unpin, <ET as EngineTypes>::CustomNode: Unpin, <<ET as EngineTypes>::File as File>::SourceRefID: Unpin, <ET as EngineTypes>::Token: Unpin,

§

impl<ET> UnsafeUnpin for HNode<ET>

§

impl<ET> UnwindSafe for HNode<ET>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<ET, Err, A> IntoErr<ET, Err> for A
where ET: EngineTypes, Err: From<A>,

Source§

fn into_err( self, _aux: &EngineAux<ET>, _state: &<ET as EngineTypes>::State, ) -> Err

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more