Skip to main content

Pipeline

Struct Pipeline 

Source
pub struct Pipeline { /* private fields */ }
Expand description

Pipeline for text shaping, rendering, and export.

Use Pipeline::process for the normal fast path. Use Pipeline::execute when you need the explicit stage list and a prepared PipelineContext. In the default configuration, only the shaping, rendering, and export stages do work; the earlier stages are placeholders.

use typf_core::Pipeline;

let pipeline = Pipeline::builder()
    .shaper(my_shaper)
    .renderer(my_renderer)
    .exporter(my_exporter)
    .build()?;

let result = pipeline.process(
    "Hello, world!",
    font,
    &shaping_params,
    &render_params,
)?;

Implementations§

Source§

impl Pipeline

Source

pub fn builder() -> PipelineBuilder

Source

pub fn process( &self, text: &str, font: Arc<dyn FontRef>, shaping_params: &ShapingParams, render_params: &RenderParams, ) -> Result<Vec<u8>>

Run the configured shaper, renderer, and exporter directly.

Source

pub fn execute(&self, context: PipelineContext) -> Result<PipelineContext>

Auto Trait Implementations§

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.