Struct nu_cli::DescriptionMenu

source ·

pub struct DescriptionMenu { /* private fields */ }

Expand description

Completion menu definition

Implementations

source

impl DescriptionMenu

source

pub fn with_name(self, name: &str) -> Self

Menu builder with new name

source

pub fn with_text_style(self, text_style: Style) -> Self

Menu builder with new value for text style

source

pub fn with_selected_text_style(self, selected_text_style: Style) -> Self

Menu builder with new value for text style

source

pub fn with_description_text_style(self, description_text_style: Style) -> Self

Menu builder with new value for text style

source

pub fn with_columns(self, columns: u16) -> Self

Menu builder with new columns value

source

pub fn with_column_width(self, col_width: Option<usize>) -> Self

Menu builder with new column width value

source

pub fn with_column_padding(self, col_padding: usize) -> Self

Menu builder with new column width value

source

pub fn with_selection_rows(self, selection_rows: u16) -> Self

Menu builder with new selection rows value

source

pub fn with_description_rows(self, description_rows: usize) -> Self

Menu builder with new description rows value

source

pub fn with_marker(self, marker: String) -> Self

Menu builder with marker

source

pub fn with_only_buffer_difference(self, only_buffer_difference: bool) -> Self

Menu builder with new only buffer difference

Trait Implementations

source

impl Default for DescriptionMenu

source

fn default() -> Self

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

source

fn name(&self) -> &str

Menu name

source

fn indicator(&self) -> &str

Menu indicator

source

fn is_active(&self) -> bool

Deactivates context menu

source

fn can_quick_complete(&self) -> bool

The menu stays active even with one record

source

fn can_partially_complete(
    &mut self,
    _values_updated: bool,
    _editor: &mut Editor,
    _completer: &mut dyn Completer
) -> bool

The menu does not need to partially complete

source

fn menu_event(&mut self, event: MenuEvent)

Selects what type of event happened with the menu

source

fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer)

Updates menu values

source

fn update_working_details(
    &mut self,
    editor: &mut Editor,
    completer: &mut dyn Completer,
    painter: &Painter
)

The working details for the menu changes based on the size of the lines collected from the completer

source

fn replace_in_buffer(&self, editor: &mut Editor)

The buffer gets replaced in the Span location

source

fn min_rows(&self) -> u16

Minimum rows that should be displayed by the menu

source

fn get_values(&self) -> &[Suggestion]

Gets values from filler that will be displayed in the menu

source

fn menu_required_lines(&self, _terminal_columns: u16) -> u16

Calculates the real required lines for the menu considering how many lines wrap the terminal or if entries have multiple lines Read more

source

fn menu_string(&self, _available_lines: u16, use_ansi_coloring: bool) -> String

Creates the menu representation as a string which will be painted by the painter

Auto Trait Implementations

impl RefUnwindSafe for DescriptionMenu

impl Unpin for DescriptionMenu

impl UnwindSafe for DescriptionMenu

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

Set the background color generically. Read more

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct nu_cli::DescriptionMenu

Implementations

impl DescriptionMenu

pub fn with_name(self, name: &str) -> Self

pub fn with_text_style(self, text_style: Style) -> Self

pub fn with_selected_text_style(self, selected_text_style: Style) -> Self

pub fn with_description_text_style(self, description_text_style: Style) -> Self

pub fn with_columns(self, columns: u16) -> Self

pub fn with_column_width(self, col_width: Option<usize>) -> Self

pub fn with_column_padding(self, col_padding: usize) -> Self

pub fn with_selection_rows(self, selection_rows: u16) -> Self

pub fn with_description_rows(self, description_rows: usize) -> Self

pub fn with_marker(self, marker: String) -> Self

pub fn with_only_buffer_difference(self, only_buffer_difference: bool) -> Self

Trait Implementations

impl Default for DescriptionMenu

fn default() -> Self

impl Menu for DescriptionMenu

fn name(&self) -> &str

fn indicator(&self) -> &str

fn is_active(&self) -> bool

fn can_quick_complete(&self) -> bool

fn can_partially_complete( &mut self, _values_updated: bool, _editor: &mut Editor, _completer: &mut dyn Completer) -> bool

fn menu_event(&mut self, event: MenuEvent)

fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer)

fn update_working_details( &mut self, editor: &mut Editor, completer: &mut dyn Completer, painter: &Painter)

fn replace_in_buffer(&self, editor: &mut Editor)

fn min_rows(&self) -> u16

fn get_values(&self) -> &[Suggestion]

fn menu_required_lines(&self, _terminal_columns: u16) -> u16

fn menu_string(&self, _available_lines: u16, use_ansi_coloring: bool) -> String

Auto Trait Implementations

impl RefUnwindSafe for DescriptionMenu

impl Send for DescriptionMenu

impl Sync for DescriptionMenu

impl Unpin for DescriptionMenu

impl UnwindSafe for DescriptionMenu

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn can_partially_complete(
&mut self,
_values_updated: bool,
_editor: &mut Editor,
_completer: &mut dyn Completer
) -> bool

fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
painter: &Painter
)

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,