Skip to main content

TextBuffer

Struct TextBuffer 

Source
pub struct TextBuffer { /* private fields */ }
Expand description

A UTF-8 text buffer with UTF-16-indexed access.

All public offsets are UTF-16 code units, matching the JavaScript side.

Implementations§

Source§

impl TextBuffer

Source

pub fn new(text: impl Into<String>) -> Self

Source

pub fn as_str(&self) -> &str

Source

pub fn len16(&self) -> usize

Length in UTF-16 code units, matching JS String.prototype.length.

Source

pub fn char_count(&self) -> usize

Length in Unicode scalar values. Differs from Self::len16 wherever a character outside the BMP occurs.

Source

pub fn is_empty(&self) -> bool

Source

pub fn slice16(&self, start: usize, end: usize) -> Result<String, FcError>

Extracts a substring using UTF-16 offsets.

Source

pub fn replace16( &mut self, start: usize, end: usize, replacement: &str, ) -> Result<Range16, FcError>

Replaces a UTF-16 range, returning the range the inserted text now occupies so a caller can place the caret after an edit without recomputing it.

Source

pub fn lines16(&self) -> Vec<Range16>

Splits into lines, reporting each line’s range in UTF-16 units.

Terminators are not included, and a trailing newline produces a final empty line – the behaviour an editor needs so the caret can sit on the line after a final newline.

Source

pub fn line_at(&self, offset: usize) -> Result<Range16, FcError>

Returns the UTF-16 range of the line containing offset.

Source

pub fn count16(&self, start: usize, end: usize) -> Result<usize, FcError>

Counts characters in a UTF-16 range, for the character counts a UI displays – counting bytes or code units there would be visibly wrong.

Source§

impl TextBuffer

Source

pub fn js_from(text: String) -> TextBuffer

Constructs a buffer from JS.

constructor rather than a static factory: it makes the type instantiable from JavaScript, which wasm_bindgen otherwise refuses because it only generates ABI glue for values it can move across the boundary.

Source

pub fn text(&self) -> String

Source

pub fn js_len16(&self) -> usize

Source

pub fn js_char_count(&self) -> usize

Source

pub fn js_lines16(&self) -> Vec<u32>

Returns flat [start, end, ...] coordinates, one pair per line.

Source

pub fn js_slice16(&self, start: usize, end: usize) -> Result<String, JsValue>

Source

pub fn js_replace16( &mut self, start: usize, end: usize, replacement: &str, ) -> Result<Vec<u32>, JsValue>

Replaces a range and returns the [start, end] the inserted text now occupies, so the caller can place the caret without recomputing it.

Source

pub fn js_line_at(&self, offset: usize) -> Result<Vec<u32>, JsValue>

Source

pub fn js_count_chars(&self, start: usize, end: usize) -> Result<usize, JsValue>

Counts characters, not bytes or UTF-16 units, in a range.

Trait Implementations§

Source§

impl Clone for TextBuffer

Source§

fn clone(&self) -> Self

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 TextBuffer

Source§

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

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

impl Default for TextBuffer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<TextBuffer> for JsValue

Source§

fn from(value: TextBuffer) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for TextBuffer

Source§

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for TextBuffer

Source§

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for TextBuffer

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<TextBuffer>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for TextBuffer

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for TextBuffer

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for TextBuffer

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<TextBuffer>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for TextBuffer

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<TextBuffer>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for TextBuffer

Source§

impl SupportsInstanceProperty for TextBuffer

Source§

impl SupportsStaticProperty for TextBuffer

Source§

impl TryFromJsValue for TextBuffer

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for TextBuffer

Source§

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

Source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[TextBuffer]>

Source§

impl VectorIntoWasmAbi for TextBuffer

Source§

impl WasmDescribe for TextBuffer

Source§

impl WasmDescribeVector for TextBuffer

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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more