Skip to main content

Engine

Struct Engine 

Source
pub struct Engine<P, R, H, F = NoFontSystem> { /* private fields */ }
Expand description

Engine initialized from a format image with associated resource, platform, and font boundaries.

Implementations§

Source§

impl<P, R, H> Engine<P, R, H>

Source

pub fn new( profile: P, format: FormatImage, resources: R, platform: H, ) -> Result<Self, BuildError>

Constructs an engine without a font system.

Source§

impl<P, R, H, F> Engine<P, R, H, F>

Source

pub fn new_with_fonts( profile: P, format: FormatImage, resources: R, platform: H, fonts: F, ) -> Result<Self, BuildError>

Constructs an engine with an explicit font system.

Source

pub fn builder(profile: P) -> EngineBuilder<P, (), (), NoFontSystem>

Returns a staged builder for this engine profile.

Source

pub fn new_session(&self) -> EngineSession<'_, P, R, H, F>

Create a session, the session holds a clone of the mutable format state.

Source

pub fn profile(&self) -> &P

Returns the engine profile.

Source

pub fn semantics(&self) -> &EngineSemantics

Computed semantics derived from the engine profile.

Source

pub fn format(&self) -> &FormatImage

Returns the loaded format image.

Source

pub fn generated_format(&self) -> &GeneratedFormatCache

Preloaded generated engine format image.

Source

pub fn resources(&self) -> &R

Returns the resource provider.

Source

pub fn platform(&self) -> &H

Returns the platform adapter.

Source

pub fn fonts(&self) -> &F

Returns the font system.

Source

pub fn primitives(&self) -> &PrimitiveRegistry

Primitive dispatch table for this engine profile.

Trait Implementations§

Source§

impl<P: Clone, R: Clone, H: Clone, F: Clone> Clone for Engine<P, R, H, F>

Source§

fn clone(&self) -> Engine<P, R, H, F>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<P: Debug, R: Debug, H: Debug, F: Debug> Debug for Engine<P, R, H, F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P, R, H, F = NoFontSystem> !Send for Engine<P, R, H, F>

§

impl<P, R, H, F = NoFontSystem> !Sync for Engine<P, R, H, F>

§

impl<P, R, H, F> Freeze for Engine<P, R, H, F>
where P: Freeze, R: Freeze, H: Freeze, F: Freeze,

§

impl<P, R, H, F> RefUnwindSafe for Engine<P, R, H, F>

§

impl<P, R, H, F> Unpin for Engine<P, R, H, F>
where P: Unpin, R: Unpin, H: Unpin, F: Unpin,

§

impl<P, R, H, F> UnsafeUnpin for Engine<P, R, H, F>

§

impl<P, R, H, F> UnwindSafe for Engine<P, R, H, F>

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.