Struct CommandSuggestion 

#[non_exhaustive]
pub struct CommandSuggestion {
    pub text: String,
    pub tooltip: Option<String>,
}

One completion a custom argument offers for the text being typed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

The text that replaces the typed prefix.

tooltip: Option<String>

An optional explanation shown beside the completion.

Implementations

impl CommandSuggestion

pub fn new(text: impl Into<String>) -> CommandSuggestion

A completion without a tooltip.

pub fn with_tooltip( text: impl Into<String>, tooltip: impl Into<String>, ) -> CommandSuggestion

A completion with an explanation.

Trait Implementations

impl Clone for CommandSuggestion

fn clone(&self) -> CommandSuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSuggestion

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

Formats the value using the given formatter.

impl Eq for CommandSuggestion

impl PartialEq for CommandSuggestion

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandSuggestion

impl Wire for CommandSuggestion

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<CommandSuggestion, WireError>

Decodes one value, leaving any following bytes for the caller.