Enum ResponseKind

pub enum ResponseKind {
    Ok,
    Error,
    Blob,
    Text,
    DirEntries,
    Changed,
    Exists,
    Metadata,
    SearchStarted,
    SearchResults,
    SearchDone,
    ProcSpawned,
    ProcStdout,
    ProcStderr,
    ProcDone,
    SystemInfo,
    Version,
}

Auto-generated discriminant enum variants

Variants

Ok

General okay with no extra data, returned in cases like creating or removing a directory, copying a file, or renaming a file

Error

General-purpose failure that occurred from some request

Blob

Response containing some arbitrary, binary data

Text

Response containing some arbitrary, text data

DirEntries

Response to reading a directory

Changed

Response to a filesystem change for some watched file, directory, or symlink

Exists

Response to checking if a path exists

Metadata

Represents metadata about some filesystem object (file, directory, symlink) on remote machine

SearchStarted

Represents a search being started

SearchResults

Represents some subset of results for a search query (may not be all of them)

SearchDone

Represents a search being completed

ProcSpawned

Response to starting a new process

ProcStdout

Actively-transmitted stdout as part of running process

ProcStderr

Actively-transmitted stderr as part of running process

ProcDone

Response to a process finishing

SystemInfo

Response to retrieving information about the server and the system it is on

Version

Response to retrieving information about the server’s version

Implementations

impl ResponseKind

pub fn is_ok(&self) -> bool

pub fn is_error(&self) -> bool

pub fn is_blob(&self) -> bool

pub fn is_text(&self) -> bool

pub fn is_dir_entries(&self) -> bool

pub fn is_changed(&self) -> bool

pub fn is_exists(&self) -> bool

pub fn is_metadata(&self) -> bool

pub fn is_search_started(&self) -> bool

pub fn is_search_results(&self) -> bool

pub fn is_search_done(&self) -> bool

pub fn is_proc_spawned(&self) -> bool

pub fn is_proc_stdout(&self) -> bool

pub fn is_proc_stderr(&self) -> bool

pub fn is_proc_done(&self) -> bool

pub fn is_system_info(&self) -> bool

pub fn is_version(&self) -> bool

Trait Implementations

impl AsRef<str> for ResponseKind

fn as_ref(&self) -> &str

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

impl Clone for ResponseKind

fn clone(&self) -> ResponseKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResponseKind

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

Formats the value using the given formatter.

impl EnumMessage for ResponseKind

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 Response> for ResponseKind

fn from(val: &'_enum Response) -> ResponseKind

Converts to this type from the input type.

impl From<Response> for ResponseKind

fn from(val: Response) -> ResponseKind

Converts to this type from the input type.

impl FromStr for ResponseKind

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for ResponseKind

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 ResponseKind

type Iterator = ResponseKindIter

fn iter() -> ResponseKindIter

impl Ord for ResponseKind

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ResponseKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ResponseKind

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ResponseKind

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 ResponseKind

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ResponseKind

impl Eq for ResponseKind

impl StructuralPartialEq for ResponseKind