Struct TextInput 

pub struct TextInput<B> { /* private fields */ }

Available on crate feature ui only.

▦ 𝐓 One-line editable text state over caller-chosen storage.

---

^{📍 ui/text::TextInput}

^{📦 size_of::<TextInput<&mut [u8]>>() == 28 bytes / 224 bits #️⃣ #[cfg(target_pointer_width = “32”)] ⚗️Option<T> 🟰 T}

^{📦 size_of::<TextInput<&mut [u8]>>() == 56 bytes / 448 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T> 🟰 T}

---

The storage type determines ownership:

• TextInput<[u8; N]> owns inline storage.
• TextInput<&mut [u8]> edits caller-provided storage.
• TextInput<String> uses growable allocated storage.

Implementations

impl<B> TextInput<B>

pub const fn from_storage(storage: B) -> Self

Creates an empty text input over storage.

pub const fn from_storage_config(storage: B, config: TextInputConfig) -> Self

Creates an empty text input over storage, with config.

pub const fn len(&self) -> usize

Returns the initialized length, in bytes.

pub const fn is_empty(&self) -> bool

Returns whether the input is empty.

pub const fn cursor(&self) -> usize

Returns the cursor byte position.

pub const fn is_cursor_start(&self) -> bool

Returns whether the cursor is at the beginning.

pub const fn is_cursor_end(&self) -> bool

Returns whether the cursor is at the end.

pub const fn config(&self) -> TextInputConfig

Returns the input configuration.

pub const fn set_config(&mut self, config: TextInputConfig)

Sets the input configuration.

pub const fn storage(&self) -> &B

Returns the underlying storage.

pub const fn storage_mut(&mut self) -> &mut B

Returns mutable access to the underlying storage.

pub fn into_storage(self) -> B

Consumes the input and returns its storage.

impl<const CAP: usize> TextInput<[u8; CAP]>

pub const fn new() -> Self

Creates an empty input with inline storage.

pub const fn capacity(&self) -> usize

Returns the storage capacity, in bytes.

pub const fn remaining_capacity(&self) -> usize

Returns the remaining storage capacity, in bytes.

pub fn as_bytes(&self) -> &[u8]

Returns the initialized bytes.

pub fn as_str(&self) -> &str

Returns the initialized UTF-8 text.

pub fn try_set_cursor(&mut self, cursor: usize) -> bool

Tries to set the cursor to a UTF-8 boundary.

pub fn view(&self) -> TextInputView<'_>

Returns a borrowed input view.

pub fn apply(&mut self, action: TextInputAction) -> TextInputOutcome

Applies an editing action.

impl<'a> TextInput<&'a mut [u8]>

pub const fn from_buf(buf: &'a mut [u8]) -> Self

Creates an empty input over caller-provided storage.

pub const fn from_buf_config(buf: &'a mut [u8], config: TextInputConfig) -> Self

Creates an empty input over caller-provided storage, with config.

pub const fn capacity(&self) -> usize

Returns the storage capacity, in bytes.

pub const fn remaining_capacity(&self) -> usize

Returns the remaining storage capacity, in bytes.

pub fn as_bytes(&self) -> &[u8]

Returns the initialized bytes.

pub fn as_str(&self) -> &str

Returns the initialized UTF-8 text.

pub fn try_set_cursor(&mut self, cursor: usize) -> bool

Tries to set the cursor to a UTF-8 boundary.

pub fn view(&self) -> TextInputView<'_>

Returns a borrowed input view.

pub fn apply(&mut self, action: TextInputAction) -> TextInputOutcome

Applies an editing action.

impl TextInput<String>

pub fn new_alloc() -> Self

Available on crate feature alloc only.

Creates an empty allocated input.

pub fn from_string(storage: String) -> Self

Available on crate feature alloc only.

Creates an input from an allocated string.

pub fn as_bytes(&self) -> &[u8]

Available on crate feature alloc only.

Returns the initialized bytes.

pub fn as_str(&self) -> &str

Available on crate feature alloc only.

Returns the initialized UTF-8 text.

pub fn try_set_cursor(&mut self, cursor: usize) -> bool

Available on crate feature alloc only.

Tries to set the cursor to a UTF-8 boundary.

pub fn view(&self) -> TextInputView<'_>

Available on crate feature alloc only.

Returns a borrowed input view.

pub fn apply(&mut self, action: TextInputAction) -> TextInputOutcome

Available on crate feature alloc only.

Applies an editing action.

Trait Implementations

impl<B: Clone> Clone for TextInput<B>

fn clone(&self) -> TextInput<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for TextInput<B>

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

Formats the value using the given formatter.

impl<const CAP: usize> Default for TextInput<[u8; CAP]>

fn default() -> Self

Returns the “default value” for a type.

impl<B: Eq> Eq for TextInput<B>

impl<B: PartialEq> PartialEq for TextInput<B>

fn eq(&self, other: &TextInput<B>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B: PartialEq> StructuralPartialEq for TextInput<B>