Struct swash::shape::cluster::GlyphCluster

source ·
pub struct GlyphCluster<'a> {
    pub source: SourceRange,
    pub info: ClusterInfo,
    pub glyphs: &'a [Glyph],
    pub components: &'a [SourceRange],
    pub data: UserData,
}
Expand description

Collection of glyphs and associated metadata corresponding to one or more source clusters.

Fields§

§source: SourceRange

Full source range of the cluster in original units supplied to the shaper.

§info: ClusterInfo

Information about the textual content of the cluster.

§glyphs: &'a [Glyph]

Sequence of glyphs for the cluster. May be empty for clusters whose source consisted entirely of control characters.

§components: &'a [SourceRange]

If the cluster is a ligature, this contains the source range of each ligature component. Empty otherwise.

§data: UserData

Arbitrary user data– taken from the initial character of the cluster.

Implementations§

source§

impl<'a> GlyphCluster<'a>

source

pub fn is_empty(&self) -> bool

Returns true if the cluster is empty. Empty clusters still represent characters in the source text, but contain no glyphs. This will be true, for example, with newline sequences (\n or \r\n) as well as other control characters.

source

pub fn is_simple(&self) -> bool

Returns true if the cluster contains a single glyph. Note that a simple cluster can also be a ligature.

source

pub fn is_ligature(&self) -> bool

Returns true if the cluster corresponds to multiple source clusters. Note that a ligature cluster can also be complex.

source

pub fn is_complex(&self) -> bool

Returns true if the cluster is complex– that is if it contains more than one glyph. This will be true for clusters containing marks and is also commonly true for syllabic languages such as those in the Indic family.

source

pub fn advance(&self) -> f32

Computes the full advance width or height of the cluster.

Trait Implementations§

source§

impl<'a> Clone for GlyphCluster<'a>

source§

fn clone(&self) -> GlyphCluster<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for GlyphCluster<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Copy for GlyphCluster<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for GlyphCluster<'a>

§

impl<'a> RefUnwindSafe for GlyphCluster<'a>

§

impl<'a> Send for GlyphCluster<'a>

§

impl<'a> Sync for GlyphCluster<'a>

§

impl<'a> Unpin for GlyphCluster<'a>

§

impl<'a> UnwindSafe for GlyphCluster<'a>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.