Skip to main content

StomachData

tex_engine::engine::stomach

Struct StomachData 

Source 
pub struct StomachData<ET: EngineTypes> {
Show 24 fields
    pub page: Vec<VNode<ET>>,
    pub open_lists: Vec<NodeList<ET>>,
    pub pagegoal: ET::Dim,
    pub pagetotal: ET::Dim,
    pub pagestretch: ET::Dim,
    pub pagefilstretch: ET::Dim,
    pub pagefillstretch: ET::Dim,
    pub pagefilllstretch: ET::Dim,
    pub pageshrink: ET::Dim,
    pub pagedepth: ET::Dim,
    pub prevdepth: ET::Dim,
    pub spacefactor: i32,
    pub topmarks: HMap<usize, TokenList<ET::Token>>,
    pub firstmarks: HMap<usize, TokenList<ET::Token>>,
    pub botmarks: HMap<usize, TokenList<ET::Token>>,
    pub splitfirstmarks: HMap<usize, TokenList<ET::Token>>,
    pub splitbotmarks: HMap<usize, TokenList<ET::Token>>,
    pub page_contains_boxes: bool,
    pub lastpenalty: i32,
    pub prevgraf: u16,
    pub in_output: bool,
    pub deadcycles: usize,
    pub vadjusts: Vec<VNode<ET>>,
    pub inserts: Vec<(usize, Box<[VNode<ET>]>)>,

}
Expand description

All the mutable data of the Stomach - i.e. the current page, the current list(s), etc.

TODO: should be overhauled; this is just a rough approximation of what needs to happen and can be made more efficient and more correct.

Fields§

§page: Vec<VNode<ET>>§open_lists: Vec<NodeList<ET>>§pagegoal: ET::Dim§pagetotal: ET::Dim§pagestretch: ET::Dim§pagefilstretch: ET::Dim§pagefillstretch: ET::Dim§pagefilllstretch: ET::Dim§pageshrink: ET::Dim§pagedepth: ET::Dim§prevdepth: ET::Dim§spacefactor: i32§topmarks: HMap<usize, TokenList<ET::Token>>§firstmarks: HMap<usize, TokenList<ET::Token>>§botmarks: HMap<usize, TokenList<ET::Token>>§splitfirstmarks: HMap<usize, TokenList<ET::Token>>§splitbotmarks: HMap<usize, TokenList<ET::Token>>§page_contains_boxes: bool§lastpenalty: i32§prevgraf: u16§in_output: bool§deadcycles: usize§vadjusts: Vec<VNode<ET>>§inserts: Vec<(usize, Box<[VNode<ET>]>)>

Implementations§

Source§

impl<ET: EngineTypes> StomachData<ET>

Source

pub fn mode(&self) -> TeXMode

The current TeXMode (indicating the type of node list currently open)

Trait Implementations§

Source§

impl<ET: Clone + EngineTypes> Clone for StomachData<ET>
where ET::Dim: Clone, ET::Token: Clone,

Source§

fn clone(&self) -> StomachData<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 StomachData<ET>
where ET::Dim: Debug, ET::Token: Debug,

Source§

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

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

impl<ET: EngineTypes> Default for StomachData<ET>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<ET> Freeze for StomachData<ET>
where <ET as EngineTypes>::Dim: Freeze,

§

impl<ET> !RefUnwindSafe for StomachData<ET>

§

impl<ET> !Send for StomachData<ET>

§

impl<ET> !Sync for StomachData<ET>

§

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

§

impl<ET> UnsafeUnpin for StomachData<ET>
where <ET as EngineTypes>::Dim: UnsafeUnpin,

§

impl<ET> !UnwindSafe for StomachData<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<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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