Expand description
§distant core
§Details
The distant-core
library supplies the client and server interfaces along with
a client implementation for distant. The library exposes an API that downstream
libraries such as distant-local
and distant-ssh2
can implement to provide a
distant-compatible interface.
§Installation
You can import the dependency by adding the following to your Cargo.toml
:
[dependencies]
distant-core = "0.20"
§License
This project is licensed under either of
Apache License, Version 2.0, (LICENSE-APACHE or apache-license) MIT license (LICENSE-MIT or mit-license) at your option.
Re-exports§
pub use distant_net as net;
pub use distant_protocol as protocol;
Structs§
- Distant
ApiServer Handler - Represents a
ServerHandler
that leverages an API compliant withdistant
- Distant
Ctx - Represents the context provided to the
DistantApi
for incoming requests - Distant
Single KeyCredentials - Represents credentials used for a distant server that is maintaining a single key across all connections
- LspContent
- Represents the content for LSP data
- LspContent
Parse Error - LspHeader
- Represents the header for LSP data
- LspMsg
- Represents some data being communicated to/from an LSP consisting of a header and content part
- Remote
Command - A
RemoteProcess
builder providing support to configure before spawning the process on a remote machine - Remote
LspCommand - A
RemoteLspProcess
builder providing support to configure before spawning the process on a remote machine - Remote
LspProcess - Represents an LSP server process on a remote machine
- Remote
LspStderr - A handle to a remote LSP process’ stderr
- Remote
LspStdin - A handle to a remote LSP process’ standard input (stdin)
- Remote
LspStdout - A handle to a remote LSP process’ standard output (stdout)
- Remote
Output - Remote
Process - Represents a process on a remote machine
- Remote
Process Killer - A handle to the channel to kill a remote process
- Remote
Process Resizer - A handle to the channel to kill a remote process
- Remote
Status - Remote
Stderr - A handle to a remote process’ stderr
- Remote
Stdin - A handle to a remote process’ standard input (stdin)
- Remote
Stdout - A handle to a remote process’ standard output (stdout)
- Searcher
- Represents a searcher for files, directories, and symlinks on the filesystem
- Watcher
- Represents a watcher of some path on a remote machine
Enums§
Traits§
- Distant
Api - Interface to support the suite of functionality available with distant, which can be used to build other servers that are compatible with distant
- Distant
Channel Ext - Provides convenience functions on top of a
Channel
Type Aliases§
- Async
Return - Distant
Channel - Represents a
Channel
that communicates using the distant protocol - Distant
Client - Represents a
Client
that communicates using the distant protocol