corsa_client 0.15.0

Typed stdio API client bindings for Corsa
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! Editor-style `ApiClient` methods.

use super::{
    ApiClient, DocumentIdentifier, ProjectHandle, SnapshotHandle,
    requests_core::SymbolAtPositionRequest,
    requests_editor::{CompletionAtPositionRequest, RenameAtPositionRequest},
};
use crate::{
    Result,
    lsp_types::{
        CompletionContext, CompletionResponse, GotoDefinitionResponse, Hover, Location,
        WorkspaceEdit,
    },
};

impl ApiClient {
    /// Returns hover information at a UTF-16 position.
    pub async fn get_hover_at_position(
        &self,
        snapshot: SnapshotHandle,
        project: ProjectHandle,
        file: impl Into<DocumentIdentifier>,
        position: u32,
    ) -> Result<Option<Hover>> {
        self.call_optional("getHoverAtPosition", SymbolAtPositionRequest {
            snapshot,
            project,
            file: file.into(),
            position,
        })
        .await
        .map_err(|error| {
            ApiClient::map_missing_method(
                error,
                "hover is not supported by this runtime; check describeCapabilities before requesting editor features",
            )
        })
    }

    /// Returns definitions reachable from a UTF-16 position.
    pub async fn get_definition_at_position(
        &self,
        snapshot: SnapshotHandle,
        project: ProjectHandle,
        file: impl Into<DocumentIdentifier>,
        position: u32,
    ) -> Result<Option<GotoDefinitionResponse>> {
        self.call_optional("getDefinitionAtPosition", SymbolAtPositionRequest {
            snapshot,
            project,
            file: file.into(),
            position,
        })
        .await
        .map_err(|error| {
            ApiClient::map_missing_method(
                error,
                "definition lookup is not supported by this runtime; check describeCapabilities before requesting editor features",
            )
        })
    }

    /// Returns references reachable from a UTF-16 position.
    pub async fn get_references_at_position(
        &self,
        snapshot: SnapshotHandle,
        project: ProjectHandle,
        file: impl Into<DocumentIdentifier>,
        position: u32,
    ) -> Result<Vec<Location>> {
        self.call::<Option<Vec<Location>>, _>(
            "getReferencesAtPosition",
            SymbolAtPositionRequest {
                snapshot,
                project,
                file: file.into(),
                position,
            },
        )
        .await
        .map(|locations| locations.unwrap_or_default())
        .map_err(|error| {
            ApiClient::map_missing_method(
                error,
                "reference lookup is not supported by this runtime; check describeCapabilities before requesting editor features",
            )
        })
    }

    /// Returns rename edits reachable from a UTF-16 position.
    pub async fn get_rename_at_position(
        &self,
        snapshot: SnapshotHandle,
        project: ProjectHandle,
        file: impl Into<DocumentIdentifier>,
        position: u32,
        new_name: impl Into<String>,
    ) -> Result<Option<WorkspaceEdit>> {
        self.call_optional(
            "getRenameAtPosition",
            RenameAtPositionRequest {
                snapshot,
                project,
                file: file.into(),
                position,
                new_name: new_name.into(),
            },
        )
        .await
        .map_err(|error| {
            ApiClient::map_missing_method(
                error,
                "rename is not supported by this runtime; check describeCapabilities before requesting editor features",
            )
        })
    }

    /// Returns completions reachable from a UTF-16 position.
    pub async fn get_completion_at_position(
        &self,
        snapshot: SnapshotHandle,
        project: ProjectHandle,
        file: impl Into<DocumentIdentifier>,
        position: u32,
        context: Option<CompletionContext>,
    ) -> Result<Option<CompletionResponse>> {
        self.call_optional(
            "getCompletionAtPosition",
            CompletionAtPositionRequest {
                snapshot,
                project,
                file: file.into(),
                position,
                context,
            },
        )
        .await
        .map_err(|error| {
            ApiClient::map_missing_method(
                error,
                "completion is not supported by this runtime; check describeCapabilities before requesting editor features",
            )
        })
    }
}