Struct Search 

pub struct Search { /* private fields */ }

A server search the command palette runs as the user types, registered with crate::Feature::search. The action takes the query and returns hits.

use zeyn::prelude::*;
use zeyn::SearchHit;

#[action(public)]
pub async fn search_help(query: String) -> Result<Vec<SearchHit>> {
    Ok(vec![SearchHit::new(format!("Help for {query}"), "Help", "/help")])
}

let feature = Feature::new("help").search(search_help);
assert_eq!(feature.searches().len(), 1);

Implementations

impl Search

pub fn of<A>(_action: A) -> Self

where A: Action<Input = String, Output = Result<Vec<SearchHit>>>,

pub fn meta(&self) -> &ActionMeta

pub fn run(&self, ctx: Ctx, query: String) -> BoxFuture<Result<Vec<SearchHit>>>

Runs the search. Access is checked by the caller.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.