Crate distant_protocol

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.

Structs

• Capabilities
  Set of supported capabilities for a server
• Capability
  Capability tied to a server. A capability is equivalent based on its kind and not description.
• Change
  Change to one or more paths on the filesystem.
• ChangeDetails
  Details about a change
• ChangeKindSet
  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
• RequestKindIter
  An iterator over the variants of Self
• ResponseKindIter
  An iterator over the variants of Self
• SearchQuery
  Represents a query to perform against the filesystem
• SearchQueryContentsMatch
  Represents details for a match on a file’s contents
• SearchQueryOptions
  Options associated with a search query
• SearchQueryPathMatch
  Represents details for a match on a path
• SearchQuerySubmatch
• SetPermissionsOptions
• SystemInfo
  Represents information about a system
• UnixMetadata
  Represents unix-specific metadata about some path on a remote machine.
• Version
  Represents version information.
• WindowsMetadata
  Represents windows-specific metadata about some path on a remote machine

Enums

• CapabilityKind
  Represents the kinds of capabilities available. Auto-generated discriminant enum variants
• ChangeDetailsAttributes
  Specific details about modification
• ChangeKind
  Represents a label attached to a Change that describes the kind of change.
• ErrorKind
  All possible kinds of errors that can be returned
• FileType
  Represents the type associated with a dir entry
• Msg
  Represents a wrapper around a message, supporting single and batch payloads.
• PtySizeParseError
• Request
  Represents the payload of a request to be performed on the remote machine
• RequestKind
  Auto-generated discriminant enum variants
• Response
  Represents the payload of a successful response
• ResponseKind
  Auto-generated discriminant enum variants
• SearchQueryCondition
  Condition used to find a match in a search query
• SearchQueryMatch
  Represents a match for a search query
• SearchQueryMatchData
• SearchQueryTarget
  Kind of data to examine using conditions

Constants

• PROTOCOL_VERSION
  Protocol version indicated by the tuple of (major, minor, patch).

Type Definitions

• Environment
  Mapping of environment variables
• ProcessId
  Id for a remote process
• SearchId
  Id associated with a search
• SemVer
  Version indicated by the tuple of (major, minor, patch).