Crate distant_core

Source
Expand description

§distant core

Crates.io Docs.rs Rustc 1.70.0

§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§

DistantApiServerHandler
Represents a ServerHandler that leverages an API compliant with distant
DistantCtx
Represents the context provided to the DistantApi for incoming requests
DistantSingleKeyCredentials
Represents credentials used for a distant server that is maintaining a single key across all connections
LspContent
Represents the content for LSP data
LspContentParseError
LspHeader
Represents the header for LSP data
LspMsg
Represents some data being communicated to/from an LSP consisting of a header and content part
RemoteCommand
A RemoteProcess builder providing support to configure before spawning the process on a remote machine
RemoteLspCommand
A RemoteLspProcess builder providing support to configure before spawning the process on a remote machine
RemoteLspProcess
Represents an LSP server process on a remote machine
RemoteLspStderr
A handle to a remote LSP process’ stderr
RemoteLspStdin
A handle to a remote LSP process’ standard input (stdin)
RemoteLspStdout
A handle to a remote LSP process’ standard output (stdout)
RemoteOutput
RemoteProcess
Represents a process on a remote machine
RemoteProcessKiller
A handle to the channel to kill a remote process
RemoteProcessResizer
A handle to the channel to kill a remote process
RemoteStatus
RemoteStderr
A handle to a remote process’ stderr
RemoteStdin
A handle to a remote process’ standard input (stdin)
RemoteStdout
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§

LspHeaderParseError
LspMsgParseError

Traits§

DistantApi
Interface to support the suite of functionality available with distant, which can be used to build other servers that are compatible with distant
DistantChannelExt
Provides convenience functions on top of a Channel

Type Aliases§

AsyncReturn
DistantChannel
Represents a Channel that communicates using the distant protocol
DistantClient
Represents a Client that communicates using the distant protocol