Struct DefaultEngine

Source
pub struct DefaultEngine<ET>
where ET: EngineTypes,
{ pub aux: EngineAux<ET>, pub state: <ET as EngineTypes>::State, pub filesystem: <ET as EngineTypes>::FileSystem, pub fontsystem: <ET as EngineTypes>::FontSystem, pub mouth: <ET as EngineTypes>::Mouth, pub gullet: <ET as EngineTypes>::Gullet, pub stomach: <ET as EngineTypes>::Stomach, }
Expand description

Default implementation of a TeXEngine for the provided EngineTypes.

Fieldsยง

ยงaux: EngineAux<ET>ยงstate: <ET as EngineTypes>::Stateยงfilesystem: <ET as EngineTypes>::FileSystemยงfontsystem: <ET as EngineTypes>::FontSystemยงmouth: <ET as EngineTypes>::Mouthยงgullet: <ET as EngineTypes>::Gulletยงstomach: <ET as EngineTypes>::Stomach

Trait Implementationsยง

Sourceยง

impl<ET> Default for DefaultEngine<ET>
where ET: EngineTypes,

Sourceยง

fn default() -> DefaultEngine<ET>

Returns the โ€œdefault valueโ€ for a type. Read more
ยง

impl RusTeXEngineExt for DefaultEngine<Types>

ยง

fn run_string( &mut self, file: PathBuf, content: &str, ) -> Option<TeXError<Types>>

ยง

fn do_result( &mut self, result: Option<TeXError<Types>>, settings: Settings, ) -> CompilationResult

ยง

impl RusTeXEngineT for DefaultEngine<Types>

ยง

fn initialize(log: bool)

ยง

fn get() -> DefaultEngine<Types>

ยง

fn run<S>(&mut self, file: S, settings: Settings) -> CompilationResult
where S: AsRef<str>,

ยง

fn do_file<S>(file: S, settings: Settings) -> CompilationResult
where S: AsRef<str>,

Sourceยง

impl<ET> TeXEngine for DefaultEngine<ET>
where ET: EngineTypes,

Sourceยง

type Types = ET

Sourceยง

fn get_engine_refs(&mut self) -> EngineReferences<'_, ET>

Returns mutable references to the components of the engine.
Sourceยง

fn init_file(&mut self, s: &str) -> Result<(), TeXError<Self::Types>>

Initializes the engine with a file, e.g. latex.ltx or pdftex.cfg. Read more
Sourceยง

fn run<F>(&mut self, f: F) -> Result<(), TeXError<Self::Types>>
where F: FnMut(&mut EngineReferences<'_, Self::Types>, VNode<Self::Types>) -> Result<(), TeXError<Self::Types>>,

Errors Read more
Sourceยง

fn do_file_default<F>( &mut self, s: &str, f: F, ) -> Result<(), TeXError<Self::Types>>
where F: FnMut(&mut EngineReferences<'_, Self::Types>, VNode<Self::Types>) -> Result<(), TeXError<Self::Types>>,

Compile a .tex file. All finished pages are passed to the provided continuation. Read more
Sourceยง

fn initialize_tex_primitives(&mut self)

Registers all primitives of plain TeX and sets the default variables.
Sourceยง

fn initialize_plain_tex(&mut self) -> Result<(), TeXError<Self::Types>>

Initialize the engine by processing plain.tex. Read more
Sourceยง

fn initialize_etex_primitives(&mut self)

Registers all primitives of plain TeX, e-TeX and sets the default variables.
Sourceยง

fn initialize_eplain_tex(&mut self) -> Result<(), TeXError<Self::Types>>

Initialize the engine by processing eplain.tex. Read more
Sourceยง

fn load_latex(&mut self) -> Result<(), TeXError<Self::Types>>

Initialized the engine by processing latex.ltx. Only call this (for modern LaTeX setups) after calling initialize_etex_primitives first. Read more

Auto Trait Implementationsยง

ยง

impl<ET> Freeze for DefaultEngine<ET>

ยง

impl<ET> RefUnwindSafe for DefaultEngine<ET>

ยง

impl<ET> Send for DefaultEngine<ET>

ยง

impl<ET> !Sync for DefaultEngine<ET>

ยง

impl<ET> Unpin for DefaultEngine<ET>

ยง

impl<ET> UnwindSafe for DefaultEngine<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
ยง

impl<T> ArchivePointee for T

ยง

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
ยง

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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
ยง

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

ยง

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
ยง

impl<T> Downcast for T
where T: Any,

ยง

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
ยง

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
ยง

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Anyโ€™s vtable from &Traitโ€™s.
ยง

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Anyโ€™s vtable from &mut Traitโ€™s.
ยง

impl<T> DowncastSend for T
where T: Any + Send,

ยง

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
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> Pointee for T

ยง

type Metadata = ()

The type for metadata in pointers and references to Self.
ยง

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

ยง

fn vzip(self) -> V

ยง

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
ยง

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

ยง

impl<T> Fruit for T
where T: Send + Downcast,