pub struct EngineSession<'a, P, R, H, F = NoFontSystem> { /* private fields */ }Expand description
Per fragment execution state cloned from the cached format at session creation.
Implementations§
Source§impl<P, R, H, F> EngineSession<'_, P, R, H, F>
impl<P, R, H, F> EngineSession<'_, P, R, H, F>
Sourcepub fn layout_fragment(&mut self, input: &str) -> Result<Fragment, EngineError>
pub fn layout_fragment(&mut self, input: &str) -> Result<Fragment, EngineError>
Typesets an inline math string and returns an IR fragment.
Sourcepub fn layout_fragment_input(
&mut self,
input: FragmentInput,
) -> Result<Fragment, EngineError>
pub fn layout_fragment_input( &mut self, input: FragmentInput, ) -> Result<Fragment, EngineError>
Typesets the given fragment input and returns an IR fragment.
Sourcepub fn generated_engine(&self) -> PortableTexEngine<'_>
pub fn generated_engine(&self) -> PortableTexEngine<'_>
Instantiate the generated engine seeded from cached format state.
Sourcepub fn load_input(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_input(&self, name: &str) -> Result<Resource, ResourceError>
Reads a TeX input file by name from the resource provider.
Sourcepub fn load_package(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_package(&self, name: &str) -> Result<Resource, ResourceError>
Reads a TeX package by name from the resource provider.
Sourcepub fn load_class(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_class(&self, name: &str) -> Result<Resource, ResourceError>
Reads a LaTeX document class by name from the resource provider.
Sourcepub fn load_font_definition(
&self,
name: &str,
) -> Result<Resource, ResourceError>
pub fn load_font_definition( &self, name: &str, ) -> Result<Resource, ResourceError>
Reads a font definition file by name from the resource provider.
Sourcepub fn load_package_support(
&self,
name: &str,
) -> Result<Resource, ResourceError>
pub fn load_package_support( &self, name: &str, ) -> Result<Resource, ResourceError>
Reads a package support file by name from the resource provider.
Sourcepub fn load_font_resource(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_font_resource(&self, name: &str) -> Result<Resource, ResourceError>
Reads a font file by name from the resource provider.
Sourcepub fn load_encoding(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_encoding(&self, name: &str) -> Result<Resource, ResourceError>
Reads a font encoding file by name from the resource provider.
Sourcepub fn load_map(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_map(&self, name: &str) -> Result<Resource, ResourceError>
Reads a font map file by name from the resource provider.
Sourcepub fn load_config(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_config(&self, name: &str) -> Result<Resource, ResourceError>
Reads a TeX configuration resource by name from the resource provider.
Sourcepub fn load_asset(
&self,
package: &str,
name: &str,
) -> Result<Resource, ResourceError>
pub fn load_asset( &self, package: &str, name: &str, ) -> Result<Resource, ResourceError>
Reads a package asset from the resource provider.
Sourcepub fn load_format_image(&self, name: &str) -> Result<Resource, ResourceError>
pub fn load_format_image(&self, name: &str) -> Result<Resource, ResourceError>
Reads a format image resource by name from the resource provider.
Sourcepub fn load_font(&self, query: &FontQuery) -> Result<FontData, FontError>
pub fn load_font(&self, query: &FontQuery) -> Result<FontData, FontError>
Loads a font matching the given query from the engine’s font system.
Sourcepub fn shape_text(
&self,
request: &ShapeRequest<'_>,
) -> Result<ShapedText, FontError>
pub fn shape_text( &self, request: &ShapeRequest<'_>, ) -> Result<ShapedText, FontError>
Shapes a text run via the engine’s font system.
Sourcepub fn primitive(&self, name: &str) -> Option<&PrimitiveEntry>
pub fn primitive(&self, name: &str) -> Option<&PrimitiveEntry>
Returns the primitive dispatch entry for a control sequence name.
Sourcepub fn semantics(&self) -> &EngineSemantics
pub fn semantics(&self) -> &EngineSemantics
Computed semantics for this session.
Sourcepub fn ir_emitter(&self) -> IrEmitter
pub fn ir_emitter(&self) -> IrEmitter
IR emitter seeded with session metadata; defaults to inline math fragment kind.
Sourcepub fn ir_emitter_for(&self, kind: FragmentKind) -> IrEmitter
pub fn ir_emitter_for(&self, kind: FragmentKind) -> IrEmitter
IR emitter seeded with session metadata and the given fragment kind.
Sourcepub fn state(&self) -> &SessionState
pub fn state(&self) -> &SessionState
Session local state cloned from the cached format at session creation.
Sourcepub fn state_mut(&mut self) -> &mut SessionState
pub fn state_mut(&mut self) -> &mut SessionState
Mutable access to the session’s local state.
Trait Implementations§
Source§impl<'a, P: Clone, R: Clone, H: Clone, F: Clone> Clone for EngineSession<'a, P, R, H, F>
impl<'a, P: Clone, R: Clone, H: Clone, F: Clone> Clone for EngineSession<'a, P, R, H, F>
Source§fn clone(&self) -> EngineSession<'a, P, R, H, F>
fn clone(&self) -> EngineSession<'a, P, R, H, F>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more