Skip to main content

CommandHelper

Struct CommandHelper 

Source
pub struct CommandHelper<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> CommandHelper<'a>

Source

pub fn new(database: Rc<Database<'a>>, catalog: Rc<Catalog>) -> MyResult<Self>

Trait Implementations§

Source§

impl<'a> Completer for CommandHelper<'a>

Source§

type Candidate = String

Specific completion candidate.
Source§

fn complete( &self, line: &str, pos: usize, _context: &Context<'_>, ) -> Result<(usize, Vec<Self::Candidate>)>

Takes the currently edited line with the cursor position and returns the start position and the completion candidates for the partial word to be completed. Read more
Source§

fn update( &self, line: &mut LineBuffer, start: usize, elected: &str, changes: &mut Changeset, )

Updates the edited line with the elected candidate.
Source§

impl<'a> Highlighter for CommandHelper<'a>

Source§

fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str>

Takes the currently edited line with the cursor position and returns the highlighted version (with ANSI color). Read more
Source§

fn highlight_prompt<'b, 's, 'p>( &'s self, prompt: &'p str, default: bool, ) -> Cow<'b, str>
where 's: 'b, 'p: 'b,

Takes the prompt and returns the highlighted version (with ANSI color).
Source§

fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>

Takes the hint and returns the highlighted version (with ANSI color).
Source§

fn highlight_candidate<'c>( &self, candidate: &'c str, completion: CompletionType, ) -> Cow<'c, str>

Takes the completion candidate and returns the highlighted version (with ANSI color). Read more
Source§

fn highlight_char(&self, line: &str, pos: usize, kind: CmdKind) -> bool

Tells if line needs to be highlighted when a specific char is typed or when cursor is moved under a specific char. Read more
Source§

impl<'a> Hinter for CommandHelper<'a>

Source§

type Hint = String

Specific hint type
Source§

fn hint(&self, line: &str, pos: usize, ctx: &Context<'_>) -> Option<Self::Hint>

Takes the currently edited line with the cursor position and returns the string that should be displayed or None if no hint is available for the text the user currently typed.
Source§

impl<'a> Validator for CommandHelper<'a>

Source§

fn validate( &self, context: &mut ValidationContext<'_>, ) -> Result<ValidationResult>

Takes the currently edited input and returns a ValidationResult indicating whether it is valid or not along with an option message to display about the result. The most common validity check to implement is probably whether the input is complete or not, for instance ensuring that all delimiters are fully balanced. Read more
Source§

fn validate_while_typing(&self) -> bool

Configure whether validation is performed while typing or only when user presses the Enter key. Read more
Source§

impl<'a> Helper for CommandHelper<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for CommandHelper<'a>

§

impl<'a> !RefUnwindSafe for CommandHelper<'a>

§

impl<'a> !Send for CommandHelper<'a>

§

impl<'a> !Sync for CommandHelper<'a>

§

impl<'a> Unpin for CommandHelper<'a>

§

impl<'a> UnsafeUnpin for CommandHelper<'a>

§

impl<'a> !UnwindSafe for CommandHelper<'a>

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> 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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.