Enum reedline::ReedlineMenu
source · pub enum ReedlineMenu {
EngineCompleter(Box<dyn Menu>),
HistoryMenu(Box<dyn Menu>),
WithCompleter {
menu: Box<dyn Menu>,
completer: Box<dyn Completer>,
},
}
Expand description
Allowed menus in Reedline
Variants§
EngineCompleter(Box<dyn Menu>)
Menu that uses Reedline’s completer to update its values
HistoryMenu(Box<dyn Menu>)
Menu that uses the history as its completer
WithCompleter
Menu that has its own Completer
Trait Implementations§
source§impl Menu for ReedlineMenu
impl Menu for ReedlineMenu
Selects what type of event happened with the menu
source§fn can_quick_complete(&self) -> bool
fn can_quick_complete(&self) -> bool
A menu may not be allowed to quick complete because it needs to stay
active even with one element
source§fn can_partially_complete(
&mut self,
values_updated: bool,
editor: &mut Editor,
completer: &mut dyn Completer
) -> bool
fn can_partially_complete( &mut self, values_updated: bool, editor: &mut Editor, completer: &mut dyn Completer ) -> bool
The completion menu can try to find the common string and replace it
in the given line buffer
source§fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer)
fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer)
Updates the values presented in the menu
This function needs to be defined in the trait because when the menu is
activated or the
quick_completion
option is true, the len of the values
is calculated to know if there is only one value so it can be selected
immediatelysource§fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
painter: &Painter
)
fn update_working_details( &mut self, editor: &mut Editor, completer: &mut dyn Completer, painter: &Painter )
The working details of a menu are values that could change based on
the menu conditions before it being printed, such as the number or size
of columns, etc.
In this function should be defined how the menu event is treated since
it is called just before painting the menu
source§fn replace_in_buffer(&self, editor: &mut Editor)
fn replace_in_buffer(&self, editor: &mut Editor)
Indicates how to replace in the line buffer the selected value from the menu
Calculates the real required lines for the menu considering how many lines
wrap the terminal or if entries have multiple lines
Creates the menu representation as a string which will be painted by the painter
source§fn get_values(&self) -> &[Suggestion]
fn get_values(&self) -> &[Suggestion]
Gets cached values from menu that will be displayed
source§fn set_cursor_pos(&mut self, pos: (u16, u16))
fn set_cursor_pos(&mut self, pos: (u16, u16))
Sets the position of the cursor (currently only required by the IDE menu)
Auto Trait Implementations§
impl !RefUnwindSafe for ReedlineMenu
impl Send for ReedlineMenu
impl !Sync for ReedlineMenu
impl Unpin for ReedlineMenu
impl !UnwindSafe for ReedlineMenu
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more