onoma 0.0.4

A fast, language-agnostic semantic symbol indexer and typo-resistant fuzzy finder, enabling real-time search across virtually unlimited code symbols without the need for language servers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

use std::{fmt::Debug, path::PathBuf};

#[cfg(test)]
use mockall::{automock, predicate::*};

#[cfg(test)]
use tokio_stream::wrappers::ReceiverStream;

#[cfg(test)]
use crate::models::resolved::ResolvedSymbol;

use crate::models::{self};

/// The Resolver trait defines the core functionality required for resolving
/// semantic symbols from indexed source code, within registered workspaces.
#[cfg_attr(
    test,
    automock(type QueryContext=super::types::Context; type QueryResult=ReceiverStream<ResolvedSymbol>;)
)]
pub trait Resolver: Send + Sync + Debug {
    #[allow(missing_docs)]
    type QueryContext;

    #[allow(missing_docs)]
    type QueryResult;

    /// Run a query against the indexed Symbols.
    ///
    /// It is generally advised that a stream be yielded, backed by an asynchronous
    /// task which resolves symbols from the index just-in-time. But in practice,
    /// the implementation details are left up to the resolver.
    fn query(&self, query: String, ctx: Self::QueryContext) -> Self::QueryResult;
}

/// The context in which a query was executed from.
///
/// Fields defined in here generally help to better inform the scoring logic, in order to more
/// accurately score symbols which are likely to be relevant for a given query.
#[derive(Default, Debug, Clone)]
pub struct Context {
    /// The currently focused file, when the query began.
    ///
    /// This helps influence scoring to favor symbols which are closer to
    /// the current file.
    pub current_file: Option<PathBuf>,

    /// The kinds of symbols which should be returned.
    ///
    /// Queries where the context provides [`Option::None`] or an empty [`Vec`] will return symbols of all kinds.
    pub symbol_kinds: Option<Vec<models::parsed::SymbolKind>>,
}

impl Context {
    /// Set the current file.
    #[must_use]
    pub fn with_current_file(mut self, current_file: PathBuf) -> Self {
        self.current_file = Some(current_file);

        self
    }

    /// Set the symbol kinds.
    #[must_use]
    pub fn with_symbol_kinds(mut self, symbol_kinds: &[models::parsed::SymbolKind]) -> Self {
        self.symbol_kinds = Some(symbol_kinds.to_vec());

        self
    }
}