Struct Suggestion

pub struct Suggestion {
    pub range: StringRange,
    pub tooltip: Option<String>,
    /* private fields */
}

A suggestion given to the user for what they might want to type next.

The M generic is the type of the tooltip, so for example a String or just () if you don’t care about it.

Fields

range: StringRange

tooltip: Option<String>

Implementations

impl Suggestion

pub fn new(range: StringRange, text: &str) -> Suggestion

pub fn new_with_tooltip(range: StringRange, text: &str, tooltip: String) -> Self

pub fn apply(&self, input: &str) -> String

pub fn expand(&self, command: &str, range: StringRange) -> Suggestion

pub fn text(&self) -> String

Trait Implementations

impl AzaleaWrite for Suggestion

fn azalea_write(&self, buf: &mut impl Write) -> Result<(), Error>

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 Hash for Suggestion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Suggestion

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

Tests for self and other values to be equal, and is used by ==.

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

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