Struct reedline::DefaultPrompt

pub struct DefaultPrompt {
    pub left_prompt: DefaultPromptSegment,
    pub right_prompt: DefaultPromptSegment,
}

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

impl 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

impl Clone for DefaultPrompt

fn clone(&self) -> DefaultPrompt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for DefaultPrompt

fn default() -> Self

Returns the “default value” for a type.

impl Prompt for DefaultPrompt

fn render_prompt_left(&self) -> Cow<'_, str>

Provide content of the left full prompt

fn render_prompt_right(&self) -> Cow<'_, str>

Provide content of the right full prompt

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)

fn render_prompt_multiline_indicator(&self) -> Cow<'_, str>

Indicator to show before explicit new lines

fn render_prompt_history_search_indicator( &self, history_search: PromptHistorySearch ) -> Cow<'_, str>

Render the prompt indicator for Ctrl-R history search

fn get_prompt_color(&self) -> Color

Get the default prompt color

fn get_prompt_multiline_color(&self) -> Color

Get the default multiline prompt color

fn get_indicator_color(&self) -> Color

Get the default indicator color

fn get_prompt_right_color(&self) -> Color

Get the default right prompt color

fn right_prompt_on_last_line(&self) -> bool

Whether to render right prompt on the last line