Skip to main content

ShapeResult

Struct ShapeResult 

Source
pub struct ShapeResult {
    pub glyphs: Vec<ShapedGlyph>,
    pub script_detected: Option<[u8; 4]>,
    pub direction: ShapeDirection,
    pub missing_codepoints: Vec<char>,
    pub cluster_boundaries: Vec<usize>,
}
Expand description

Extended shaping result with metadata.

Produced by SwashShaper::shape_full; includes the glyph list, the direction resolved by the shaper, the OpenType script tag (if known), and a list of Unicode codepoints that could not be mapped (glyph ID 0 / .notdef).

Fields§

§glyphs: Vec<ShapedGlyph>

Shaped glyphs in logical cluster order.

§script_detected: Option<[u8; 4]>

OpenType script tag detected (e.g. b"latn", b"arab"), or None if unknown. May be set by the caller after construction.

§direction: ShapeDirection

Direction resolved by the shaper.

§missing_codepoints: Vec<char>

Unicode codepoints that produced a .notdef glyph (ID 0).

§cluster_boundaries: Vec<usize>

Byte offsets (in the original text) where grapheme cluster boundaries fall.

Populated by SwashShaper::shape_full. Empty when SwashShaper::shape is called directly. The first entry is 0 (start of text) and the last entry is text.len() (end of text).

Implementations§

Source§

impl ShapeResult

Source

pub fn from_glyphs( glyphs: Vec<ShapedGlyph>, text: &str, direction: ShapeDirection, ) -> Self

Constructs a ShapeResult from a glyph vector, the source text, and the shaping direction.

script_detected is left as None; callers may set it afterwards.

Trait Implementations§

Source§

impl Clone for ShapeResult

Source§

fn clone(&self) -> ShapeResult

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 Debug for ShapeResult

Source§

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

Formats the value using the given formatter. Read more

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> 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.