Expand description
§distant protocol
§Details
The distant-protocol library supplies the structs and enums that make up the
messaging structure for distant.
§Installation
You can import the dependency by adding the following to your Cargo.toml:
[dependencies]
distant-protocol = "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 semver;
Structs§
- Change
- Change to a path on the filesystem.
- Change
Details - Optional details about a change.
- Change
Kind Set - Represents a distinct set of different change kinds
- Cmd
- Represents some command with arguments to execute
- DirEntry
- Represents information about a single entry within a directory
- Error
- General purpose error type that can be sent across the wire
- Metadata
- Represents metadata about some path on a remote machine.
- Permissions
- Represents permissions to apply to some path on a remote machine
- PtySize
- Represents the size associated with a remote PTY
- Response
Kind Iter - An iterator over the variants of Self
- Search
Query - Represents a query to perform against the filesystem
- Search
Query Contents Match - Represents details for a match on a file’s contents
- Search
Query Options - Options associated with a search query
- Search
Query Path Match - Represents details for a match on a path
- Search
Query Submatch - SetPermissions
Options - System
Info - Represents information about a system
- Unix
Metadata - Represents unix-specific metadata about some path on a remote machine.
- Version
- Represents version information.
- Windows
Metadata - Represents windows-specific metadata about some path on a remote machine
Enums§
- Change
Details Attribute - Specific details about modification
- Change
Kind - Represents a label attached to a
Changethat describes the kind of change. - Error
Kind - All possible kinds of errors that can be returned
- File
Type - Represents the type associated with a dir entry
- Msg
- Represents a wrapper around a message, supporting single and batch payloads.
- PtySize
Parse Error - Request
- Represents the payload of a request to be performed on the remote machine
- Response
- Represents the payload of a successful response
- Response
Kind - Auto-generated discriminant enum variants
- Search
Query Condition - Condition used to find a match in a search query
- Search
Query Match - Represents a match for a search query
- Search
Query Match Data - Search
Query Target - Kind of data to examine using conditions
Constants§
- PROTOCOL_
VERSION - Protocol version of major/minor/patch.
Functions§
- is_
compatible_ with - Returns true if the provided version is compatible with the protocol version.
Type Aliases§
- Environment
- Mapping of environment variables
- Process
Id - Id for a remote process
- Search
Id - Id associated with a search