Enum CompletionStyle 

pub enum CompletionStyle {
    List(MoveDir1D, bool),
    None,
    Prefix,
    Single,
}

What type of phrase we are completing.

Variants

List(MoveDir1D, bool)

Navigate through the list of completion candidates.

The bool argument controls whether to allow toggling back and forth between the pre-completion state and completion when there is only a single candidate in the completion list. This is usually desired in contexts where the user may want to reset back to the prefix if the completion was not what they wanted.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, EditorAction};

let ct = CompletionType::Auto;
let style = CompletionStyle::List(MoveDir1D::Next, true);
let display = CompletionDisplay::List;
let act: Action = EditorAction::Complete(style, ct, display).into();
assert_eq!(act, action!("complete -s (list -d next) -T auto -D list"));

let ct = CompletionType::Auto;
let style = CompletionStyle::List(MoveDir1D::Next, false);
let display = CompletionDisplay::List;
let act: Action = EditorAction::Complete(style, ct, display).into();
assert_eq!(act, action!("complete -s (list -d next --toggle false) -T auto -D list"));

None

Generate completion candidates, but don’t select any from the list.

This is most helpful for keybindings that allow the user to get a list of potential candidates that they can read through without actually picking any, in case they don’t know what the first character to type is.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, EditorAction};

let ct = CompletionType::Auto;
let style = CompletionStyle::None;
let display = CompletionDisplay::List;
let act: Action = EditorAction::Complete(style, ct, display).into();
assert_eq!(act, action!("complete -s none -T auto -D list"));

Prefix

Complete only the longest common prefix from the completion candidates.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, EditorAction};

let ct = CompletionType::Auto;
let style = CompletionStyle::Prefix;
let display = CompletionDisplay::List;
let act: Action = EditorAction::Complete(style, ct, display).into();
assert_eq!(act, action!("complete -s prefix -T auto -D list"));

Single

If there is only a single completion candidate, select it.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, EditorAction};

let ct = CompletionType::Auto;
let style = CompletionStyle::Single;
let display = CompletionDisplay::List;
let act: Action = EditorAction::Complete(style, ct, display).into();
assert_eq!(act, action!("complete -s single -T auto -D list"));

Trait Implementations

impl Clone for CompletionStyle

fn clone(&self) -> CompletionStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionStyle

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

Formats the value using the given formatter.

impl Eq for CompletionStyle

impl PartialEq for CompletionStyle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionStyle