Struct reedline::DefaultPrompt
source · pub struct DefaultPrompt {
pub left_prompt: DefaultPromptSegment,
pub right_prompt: DefaultPromptSegment,
}
Expand description
Simple Prompt
displaying a configurable left and a right prompt.
For more fine-tuned configuration, implement the Prompt
trait.
For the default configuration, use DefaultPrompt::default()
Fields§
§left_prompt: DefaultPromptSegment
What segment should be rendered in the left (main) prompt
right_prompt: DefaultPromptSegment
What segment should be rendered in the right prompt
Implementations§
source§impl DefaultPrompt
impl DefaultPrompt
sourcepub const fn new(
left_prompt: DefaultPromptSegment,
right_prompt: DefaultPromptSegment
) -> DefaultPrompt
pub const fn new( left_prompt: DefaultPromptSegment, right_prompt: DefaultPromptSegment ) -> DefaultPrompt
Constructor for the default prompt, which takes a configurable left and right prompt.
For less customization, use DefaultPrompt::default
.
For more fine-tuned configuration, implement the Prompt
trait.
Trait Implementations§
source§impl Clone for DefaultPrompt
impl Clone for DefaultPrompt
source§fn clone(&self) -> DefaultPrompt
fn clone(&self) -> DefaultPrompt
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Default for DefaultPrompt
impl Default for DefaultPrompt
source§impl Prompt for DefaultPrompt
impl Prompt for DefaultPrompt
source§fn render_prompt_left(&self) -> Cow<'_, str>
fn render_prompt_left(&self) -> Cow<'_, str>
Provide content off the right full prompt
source§fn render_prompt_right(&self) -> Cow<'_, str>
fn render_prompt_right(&self) -> Cow<'_, str>
Provide content off the left full prompt
source§fn render_prompt_indicator(&self, edit_mode: PromptEditMode) -> Cow<'_, str>
fn render_prompt_indicator(&self, edit_mode: PromptEditMode) -> Cow<'_, str>
Render the prompt indicator (Last part of the prompt that changes based on the editor mode)
source§fn render_prompt_multiline_indicator(&self) -> Cow<'_, str>
fn render_prompt_multiline_indicator(&self) -> Cow<'_, str>
Indicator to show before explicit new lines
source§fn render_prompt_history_search_indicator(
&self,
history_search: PromptHistorySearch
) -> Cow<'_, str>
fn render_prompt_history_search_indicator( &self, history_search: PromptHistorySearch ) -> Cow<'_, str>
Render the prompt indicator for
Ctrl-R
history searchsource§fn get_prompt_color(&self) -> Color
fn get_prompt_color(&self) -> Color
Get the default prompt color
source§fn get_prompt_multiline_color(&self) -> Color
fn get_prompt_multiline_color(&self) -> Color
Get the default multilince prompt color
source§fn get_indicator_color(&self) -> Color
fn get_indicator_color(&self) -> Color
Get the default indicator color
source§fn get_prompt_right_color(&self) -> Color
fn get_prompt_right_color(&self) -> Color
Get the default right prompt color
source§fn right_prompt_on_last_line(&self) -> bool
fn right_prompt_on_last_line(&self) -> bool
Whether to render right prompt on the last line
Auto Trait Implementations§
impl RefUnwindSafe for DefaultPrompt
impl Send for DefaultPrompt
impl Sync for DefaultPrompt
impl Unpin for DefaultPrompt
impl UnwindSafe for DefaultPrompt
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