Struct reedline::Suggestion

pub struct Suggestion {
    pub value: String,
    pub description: Option<String>,
    pub style: Option<Style>,
    pub extra: Option<Vec<String>>,
    pub span: Span,
    pub append_whitespace: bool,
}

Suggestion returned by the Completer

Fields

value: String

String replacement that will be introduced to the the buffer

description: Option<String>

Optional description for the replacement

style: Option<Style>

Optional style for the replacement

extra: Option<Vec<String>>

Optional vector of strings in the suggestion. These can be used to represent examples coming from a suggestion

span: Span

Replacement span in the buffer

append_whitespace: bool

Whether to append a space after selecting this suggestion. This helps to avoid that a completer repeats the complete suggestion.

Trait Implementations

impl Clone for Suggestion

fn clone(&self) -> Suggestion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Suggestion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Suggestion

fn default() -> Suggestion

Returns the “default value” for a type.

impl PartialEq for Suggestion

fn eq(&self, other: &Suggestion) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Suggestion

impl StructuralPartialEq for Suggestion