Struct CompletionRequest 

#[non_exhaustive]
pub struct CompletionRequest {
    pub target: CompletionTarget,
    pub argument: String,
    pub value: String,
    pub resolved: BTreeMap<String, String>,
}

A request to suggest values for an argument a user is part-way through.

Completion is what makes a resource template usable: without it a client can only show note/{path} and hope the user types a real path. It is called while the user types, so answer from state already in memory rather than scanning the vault on each keystroke.

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.

target: CompletionTarget

The prompt or resource template being filled in.

argument: String

Name of the argument or template expression being completed.

value: String

What the user has typed so far. Often empty on the first request.

resolved: BTreeMap<String, String>

Arguments of the same target the client has already resolved.

A template with more than one expression can use these to narrow later suggestions to what is reachable given the earlier choices.

Implementations

impl CompletionRequest

pub fn new( target: CompletionTarget, argument: impl Into<String>, value: impl Into<String>, ) -> Self

Construct a request for argument with the partial input value.

pub fn with_resolved(self, resolved: BTreeMap<String, String>) -> Self

Attach the arguments the client has already resolved.

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRequest

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

Formats the value using the given formatter.

impl Eq for CompletionRequest

impl PartialEq for CompletionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionRequest