Enum distant_protocol::RequestKind

pub enum RequestKind {
    FileRead,
    FileReadText,
    FileWrite,
    FileWriteText,
    FileAppend,
    FileAppendText,
    DirRead,
    DirCreate,
    Remove,
    Copy,
    Rename,
    Watch,
    Unwatch,
    Exists,
    Metadata,
    SetPermissions,
    Search,
    CancelSearch,
    ProcSpawn,
    ProcKill,
    ProcStdin,
    ProcResizePty,
    SystemInfo,
    Version,
}

Auto-generated discriminant enum variants

Variants

FileRead

Reads a file from the specified path on the remote machine

FileReadText

Reads a file from the specified path on the remote machine and treats the contents as text

FileWrite

Writes a file, creating it if it does not exist, and overwriting any existing content on the remote machine

FileWriteText

Writes a file using text instead of bytes, creating it if it does not exist, and overwriting any existing content on the remote machine

FileAppend

Appends to a file, creating it if it does not exist, on the remote machine

FileAppendText

Appends text to a file, creating it if it does not exist, on the remote machine

DirRead

Reads a directory from the specified path on the remote machine

DirCreate

Creates a directory on the remote machine

Remove

Removes a file or directory on the remote machine

Copy

Copies a file or directory on the remote machine

Rename

Moves/renames a file or directory on the remote machine

Watch

Watches a path for changes

Unwatch

Unwatches a path for changes, meaning no additional changes will be reported

Exists

Checks whether the given path exists

Metadata

Retrieves filesystem metadata for the specified path on the remote machine

SetPermissions

Sets permissions on a file, directory, or symlink on the remote machine

Search

Searches filesystem using the provided query

CancelSearch

Cancels an active search being run against the filesystem

ProcSpawn

Spawns a new process on the remote machine

ProcKill

Kills a process running on the remote machine

ProcStdin

Sends additional data to stdin of running process

ProcResizePty

Resize pty of remote process

SystemInfo

Retrieve information about the server and the system it is on

Version

Retrieve information about the server’s protocol version

Implementations

impl RequestKind

pub fn is_file_read(&self) -> bool

pub fn is_file_read_text(&self) -> bool

pub fn is_file_write(&self) -> bool

pub fn is_file_write_text(&self) -> bool

pub fn is_file_append(&self) -> bool

pub fn is_file_append_text(&self) -> bool

pub fn is_dir_read(&self) -> bool

pub fn is_dir_create(&self) -> bool

pub fn is_remove(&self) -> bool

pub fn is_copy(&self) -> bool

pub fn is_rename(&self) -> bool

pub fn is_watch(&self) -> bool

pub fn is_unwatch(&self) -> bool

pub fn is_exists(&self) -> bool

pub fn is_metadata(&self) -> bool

pub fn is_set_permissions(&self) -> bool

pub fn is_search(&self) -> bool

pub fn is_cancel_search(&self) -> bool

pub fn is_proc_spawn(&self) -> bool

pub fn is_proc_kill(&self) -> bool

pub fn is_proc_stdin(&self) -> bool

pub fn is_proc_resize_pty(&self) -> bool

pub fn is_system_info(&self) -> bool

pub fn is_version(&self) -> bool

Trait Implementations

impl AsRef<str> for RequestKind

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for RequestKind

fn clone(&self) -> RequestKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RequestKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RequestKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl EnumMessage for RequestKind

fn get_message(&self) -> Option<&'static str>

fn get_detailed_message(&self) -> Option<&'static str>

fn get_documentation(&self) -> Option<&'static str>

Get the doc comment associated with a variant if it exists.

fn get_serializations(&self) -> &'static [&'static str]

impl<'_enum> From<&'_enum Request> for RequestKind

fn from(val: &'_enum Request) -> RequestKind

Converts to this type from the input type.

impl From<Request> for RequestKind

fn from(val: Request) -> RequestKind

Converts to this type from the input type.

impl From<RequestKind> for Capability

fn from(kind: CapabilityKind) -> Self

Creates a new capability using the kind’s default message

impl FromStr for RequestKind

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<RequestKind, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for RequestKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for RequestKind

type Iterator = RequestKindIter

fn iter() -> RequestKindIter

impl Ord for RequestKind

fn cmp(&self, other: &RequestKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<RequestKind> for RequestKind

fn eq(&self, other: &RequestKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<RequestKind> for RequestKind

fn partial_cmp(&self, other: &RequestKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RequestKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for RequestKind

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<RequestKind, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for RequestKind

impl Eq for RequestKind

impl StructuralEq for RequestKind

impl StructuralPartialEq for RequestKind