Skip to main content

Editor

Struct Editor 

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

Unicode grapheme-safe bounded multiline editor state.

Implementations§

Source§

impl Editor

Source

pub fn new() -> Self

Creates an empty editor with the production byte bound.

Source

pub fn with_limit( text: impl Into<String>, max_bytes: usize, ) -> Result<Self, EditorError>

Creates an editor with an explicit byte bound.

§Errors

Rejects a zero limit or initial text larger than the limit.

Source

pub fn text(&self) -> &str

Returns the editor contents.

Source

pub const fn cursor_byte(&self) -> usize

Returns the cursor UTF-8 byte offset.

Source

pub fn cursor_display_column(&self) -> usize

Returns the display-cell cursor column within the current logical line.

Source

pub fn insert_char(&mut self, character: char) -> Result<(), EditorError>

Inserts one character at the cursor.

§Errors

Rejects input that would exceed the byte bound.

Source

pub fn insert_paste(&mut self, text: &str) -> Result<(), EditorError>

Inserts one bounded paste atomically at the cursor.

§Errors

Rejects the entire paste without mutation when it would exceed the bound.

Source

pub fn insert_newline(&mut self) -> Result<(), EditorError>

Inserts one logical newline.

§Errors

Rejects insertion at the byte bound.

Source

pub fn move_left(&mut self)

Moves left by one extended grapheme cluster.

Source

pub fn move_right(&mut self)

Moves right by one extended grapheme cluster.

Source

pub fn move_word_left(&mut self)

Moves to the beginning of the preceding Unicode word.

Source

pub fn move_word_right(&mut self)

Moves to the end of the following Unicode word.

Source

pub fn move_home(&mut self)

Moves to the start of the current logical line.

Source

pub fn move_home_or_previous_line(&mut self)

Moves to the current line start, or the preceding line start when already there.

Source

pub fn move_end(&mut self)

Moves to the end of the current logical line.

Source

pub fn move_end_or_next_line(&mut self)

Moves to the current line end, or the following line end when already there.

Source

pub fn move_up(&mut self)

Moves one logical line upward while preserving display column when possible.

Source

pub fn move_down(&mut self)

Moves one logical line downward while preserving display column when possible.

Source

pub fn delete_backward(&mut self) -> bool

Deletes one extended grapheme cluster before the cursor.

Source

pub fn delete_forward(&mut self) -> bool

Deletes one extended grapheme cluster after the cursor.

Source

pub fn delete_word_backward(&mut self) -> bool

Deletes the preceding Unicode word and intervening whitespace.

Source

pub fn delete_word_forward(&mut self) -> bool

Deletes the following Unicode word and leading separators.

Source

pub fn kill_to_line_start(&mut self) -> bool

Deletes from the cursor to the logical line start and stores it for yanking.

Source

pub fn kill_to_line_end(&mut self) -> bool

Deletes from the cursor to the logical line end and stores it for yanking.

Source

pub fn has_kill_buffer(&self) -> bool

Returns whether a previous word or line kill can be yanked.

Source

pub fn yank(&mut self) -> Result<bool, EditorError>

Inserts the most recently killed text at the cursor.

§Errors

Rejects insertion when it would exceed the configured byte bound.

Source

pub fn clear(&mut self) -> bool

Clears the editor as one undoable mutation.

Source

pub fn undo(&mut self) -> bool

Restores the most recent mutation baseline.

Source

pub fn submit(&mut self) -> Option<String>

Submits non-whitespace contents, records history, and clears the editor.

Source

pub fn previous_history(&mut self) -> bool

Replaces the current draft with the previous submitted history item.

Source

pub fn next_history(&mut self) -> bool

Moves toward the current draft in submitted history navigation.

Trait Implementations§

Source§

impl Clone for Editor

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 Editor

Source§

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

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

impl Default for Editor

Source§

fn default() -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more