type-sitter-lib 0.10.0

library code for type-sitter generated / downstream code
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

use crate::raw;
pub use captures::*;
pub use cursor::*;
pub use match_captures::*;
pub use matches::*;

/// [`QueryCaptures`]
mod captures;
/// [`QueryCursorExt`] to run typed queries
mod cursor;
/// [`QueryMatchCaptures`]
mod match_captures;
/// [`QueryMatches`]
mod matches;

/// A query which can generate type-safe matches and captures, which contain [typed nodes](Node)
pub trait Query {
    /// A match of this typed query (runtime pattern index)
    type Match<'query, 'tree: 'query>: QueryMatch<'query, 'tree>;
    /// An capture of this typed query (runtime capture index)
    type Capture<'query, 'tree: 'query>: QueryCapture<'query, 'tree>;

    /// The string used to generate this query
    fn as_str(&self) -> &'static str;

    /// The underlying tree-sitter `Query`
    fn raw(&self) -> &'static raw::Query;

    /// Wrap a tree-sitter `QueryMatch` which you know came from this query.
    ///
    /// # Safety
    /// The match must have come from this query.
    unsafe fn wrap_match<'query, 'tree>(
        &self,
        r#match: raw::QueryMatch<'query, 'tree>,
    ) -> Self::Match<'query, 'tree>;

    /// Wrap a reference to a tree-sitter `QueryMatch` which you know came from this query.
    ///
    /// # Safety
    /// The match must have come from this query.
    unsafe fn wrap_match_ref<'m, 'query, 'tree>(
        &self,
        r#match: &'m raw::QueryMatch<'query, 'tree>,
    ) -> &'m Self::Match<'query, 'tree>;

    //noinspection RsDuplicatedTraitMethodBinding -- IntelliJ inspection bug.
    /// Wrap a tree-sitter `QueryCapture` which you know came from this query.
    ///
    /// # Safety
    /// The capture must have come from this query.
    unsafe fn wrap_capture<'query, 'tree: 'query>(
        &self,
        #[cfg(feature = "yak-sitter")] capture: raw::QueryCapture<'query, 'tree>,
        #[cfg(not(feature = "yak-sitter"))] capture: raw::QueryCapture<'tree>,
    ) -> Self::Capture<'query, 'tree>;
}