Struct Routines

Source
pub struct Routines {
Show 28 fields pub eval_string: fn(routines: &Routines, world: Tracked<'_, dyn World + '_>, string: &str, span: Span, mode: EvalMode, scope: Scope) -> SourceResult<Value>, pub eval_closure: fn(func: &Func, closure: &LazyHash<Closure>, routines: &Routines, world: Tracked<'_, dyn World + '_>, introspector: Tracked<'_, Introspector>, traced: Tracked<'_, Traced>, sink: TrackedMut<'_, Sink>, route: Tracked<'_, Route<'_>>, context: Tracked<'_, Context<'_>>, args: Args) -> SourceResult<Value>, pub realize: for<'a> fn(kind: RealizationKind<'_>, engine: &mut Engine<'_>, locator: &mut SplitLocator<'_>, arenas: &'a Arenas, content: &'a Content, styles: StyleChain<'a>) -> SourceResult<Vec<Pair<'a>>>, pub layout_fragment: fn(engine: &mut Engine<'_>, content: &Content, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_frame: fn(engine: &mut Engine<'_>, content: &Content, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_list: fn(elem: &Packed<ListElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_enum: fn(elem: &Packed<EnumElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_grid: fn(elem: &Packed<GridElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_table: fn(elem: &Packed<TableElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_stack: fn(elem: &Packed<StackElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_columns: fn(elem: &Packed<ColumnsElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_move: fn(elem: &Packed<MoveElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_rotate: fn(elem: &Packed<RotateElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_scale: fn(elem: &Packed<ScaleElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_skew: fn(elem: &Packed<SkewElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_repeat: fn(elem: &Packed<RepeatElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_pad: fn(elem: &Packed<PadElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, pub layout_line: fn(elem: &Packed<LineElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_curve: fn(elem: &Packed<CurveElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_path: fn(elem: &Packed<PathElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_polygon: fn(elem: &Packed<PolygonElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_rect: fn(elem: &Packed<RectElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_square: fn(elem: &Packed<SquareElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_ellipse: fn(elem: &Packed<EllipseElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_circle: fn(elem: &Packed<CircleElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_image: fn(elem: &Packed<ImageElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, pub layout_equation_inline: fn(elem: &Packed<EquationElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Size) -> SourceResult<Vec<InlineItem>>, pub layout_equation_block: fn(elem: &Packed<EquationElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>,
}
Expand description

Defines implementation of various Typst compiler routines as a table of function pointers.

This is essentially dynamic linking and done to allow for crate splitting.

Fields§

§eval_string: fn(routines: &Routines, world: Tracked<'_, dyn World + '_>, string: &str, span: Span, mode: EvalMode, scope: Scope) -> SourceResult<Value>

Evaluates a string as code and return the resulting value.

§eval_closure: fn(func: &Func, closure: &LazyHash<Closure>, routines: &Routines, world: Tracked<'_, dyn World + '_>, introspector: Tracked<'_, Introspector>, traced: Tracked<'_, Traced>, sink: TrackedMut<'_, Sink>, route: Tracked<'_, Route<'_>>, context: Tracked<'_, Context<'_>>, args: Args) -> SourceResult<Value>

Call the closure in the context with the arguments.

§realize: for<'a> fn(kind: RealizationKind<'_>, engine: &mut Engine<'_>, locator: &mut SplitLocator<'_>, arenas: &'a Arenas, content: &'a Content, styles: StyleChain<'a>) -> SourceResult<Vec<Pair<'a>>>

Realizes content into a flat list of well-known, styled items.

§layout_fragment: fn(engine: &mut Engine<'_>, content: &Content, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out content into multiple regions.

§layout_frame: fn(engine: &mut Engine<'_>, content: &Content, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out content into a single region, producing a single frame.

§layout_list: fn(elem: &Packed<ListElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a ListElem.

§layout_enum: fn(elem: &Packed<EnumElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out an EnumElem.

§layout_grid: fn(elem: &Packed<GridElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a GridElem.

§layout_table: fn(elem: &Packed<TableElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a TableElem.

§layout_stack: fn(elem: &Packed<StackElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a StackElem.

§layout_columns: fn(elem: &Packed<ColumnsElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a ColumnsElem.

§layout_move: fn(elem: &Packed<MoveElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a MoveElem.

§layout_rotate: fn(elem: &Packed<RotateElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a RotateElem.

§layout_scale: fn(elem: &Packed<ScaleElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a ScaleElem.

§layout_skew: fn(elem: &Packed<SkewElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a SkewElem.

§layout_repeat: fn(elem: &Packed<RepeatElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a RepeatElem.

§layout_pad: fn(elem: &Packed<PadElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out a PadElem.

§layout_line: fn(elem: &Packed<LineElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a LineElem.

§layout_curve: fn(elem: &Packed<CurveElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a CurveElem.

§layout_path: fn(elem: &Packed<PathElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a PathElem.

§layout_polygon: fn(elem: &Packed<PolygonElem>, _: &mut Engine<'_>, _: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a PolygonElem.

§layout_rect: fn(elem: &Packed<RectElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a RectElem.

§layout_square: fn(elem: &Packed<SquareElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a SquareElem.

§layout_ellipse: fn(elem: &Packed<EllipseElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a EllipseElem.

§layout_circle: fn(elem: &Packed<CircleElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out a CircleElem.

§layout_image: fn(elem: &Packed<ImageElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>

Lays out an ImageElem.

§layout_equation_inline: fn(elem: &Packed<EquationElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Size) -> SourceResult<Vec<InlineItem>>

Lays out an EquationElem in a paragraph.

§layout_equation_block: fn(elem: &Packed<EquationElem>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>

Lays out an EquationElem in a flow.

Trait Implementations§

Source§

impl Hash for Routines

Source§

fn hash<H: Hasher>(&self, _: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

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

Source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

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

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
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<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
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> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,