Struct ImeSurroundingText 

pub struct ImeSurroundingText { /* private fields */ }

Defines the text surrounding the caret

Implementations

impl ImeSurroundingText

pub const MAX_TEXT_BYTES: usize = 4_000usize

The maximum size of the text excerpt.

pub fn new( text: String, cursor: usize, anchor: usize, ) -> Result<ImeSurroundingText, ImeSurroundingTextError>

Defines the text surrounding the cursor and the selection within it.

text: An excerpt of the text present in the text input field, excluding preedit. It must be limited to 4000 bytes due to backend constraints. cursor: The position of the caret, in bytes from the beginning of the string. `anchor: The position of the other end of selection, in bytes. With no selection, it should be the same as the cursor.

This may fail if the byte indices don’t fall on code point boundaries, or if the text is too long.

Examples:

A text field containing foo|bar where | denotes the caret would correspond to a value obtained by:

let s = ImeSurroundingText::new("foobar".into(), 3, 3).unwrap();

Because preedit is excluded from the text string, a text field containing foo[baz|]bar where | denotes the caret and [baz|] is the preedit would be created in exactly the same way.

pub fn into_text(self) -> String

Consumes the object, releasing the text string only. Use this call in the backend to avoid an extra clone when submitting the surrounding text.

pub fn text(&self) -> &str

pub fn cursor(&self) -> usize

pub fn anchor(&self) -> usize

Trait Implementations

impl Clone for ImeSurroundingText

fn clone(&self) -> ImeSurroundingText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImeSurroundingText

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

Formats the value using the given formatter.

impl Hash for ImeSurroundingText

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

where __H: Hasher,

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 ImeSurroundingText

fn eq(&self, other: &ImeSurroundingText) -> 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 Eq for ImeSurroundingText

impl StructuralPartialEq for ImeSurroundingText