Struct HitPosition

pub struct HitPosition { /* private fields */ }

The result of LayoutLine::x_to_index.

Implementations

impl HitPosition

pub fn index(self) -> i32

The UTF-8 byte offset of the grapheme closest to the position.

This position is relative to the start of the Layout’s text.

pub fn trailing(self) -> i32

The codepoint within the grapheme of the position.

This will always be either 0, or the number of chars (not bytes!) in the grapheme. This represents whether the user clicked near the start of the grapheme or near the end; this is important for things like resolving cursor positions.

pub fn is_inside(self) -> bool

Whether or not the position was within the bounds of the line.

If this is false, then index and trailing will always resolve to either the very first or the very last position in the line; this behaviour is dependent on the line’s resolved writing direction.

Trait Implementations

impl Clone for HitPosition

fn clone(&self) -> HitPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HitPosition

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

Formats the value using the given formatter.

impl Hash for HitPosition

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HitPosition

fn eq(&self, other: &HitPosition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for HitPosition

impl Eq for HitPosition

impl StructuralPartialEq for HitPosition