Enum Response

pub enum Response {
    Ok,
    Error(Error),
    Blob {
        data: Vec<u8>,
    },
    Text {
        data: String,
    },
    DirEntries {
        entries: Vec<DirEntry>,
        errors: Vec<Error>,
    },
    Changed(Change),
    Exists {
        value: bool,
    },
    Metadata(Metadata),
    SearchStarted {
        id: SearchId,
    },
    SearchResults {
        id: SearchId,
        matches: Vec<SearchQueryMatch>,
    },
    SearchDone {
        id: SearchId,
    },
    ProcSpawned {
        id: ProcessId,
    },
    ProcStdout {
        id: ProcessId,
        data: Vec<u8>,
    },
    ProcStderr {
        id: ProcessId,
        data: Vec<u8>,
    },
    ProcDone {
        id: ProcessId,
        success: bool,
        code: Option<i32>,
    },
    SystemInfo(SystemInfo),
    Version(Version),
}

Represents the payload of a successful response

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(Error)

General-purpose failure that occurred from some request

Blob

Response containing some arbitrary, binary data

Fields

data: Vec<u8>

Binary data associated with the response

Text

Response containing some arbitrary, text data

Fields

data: String

Text data associated with the response

DirEntries

Response to reading a directory

Fields

entries: Vec<DirEntry>

Entries contained within the requested directory

errors: Vec<Error>

Errors encountered while scanning for entries

Changed(Change)

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

Exists

Response to checking if a path exists

Fields

value: bool

Metadata(Metadata)

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

SearchStarted

Represents a search being started

Fields

id: SearchId

Arbitrary id associated with search

SearchResults

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

Fields

id: SearchId

Arbitrary id associated with search

matches: Vec<SearchQueryMatch>

Collection of matches from performing a query

SearchDone

Represents a search being completed

Fields

id: SearchId

Arbitrary id associated with search

ProcSpawned

Response to starting a new process

Fields

id: ProcessId

Arbitrary id associated with running process

ProcStdout

Actively-transmitted stdout as part of running process

Fields

id: ProcessId

Arbitrary id associated with running process

data: Vec<u8>

Data read from a process’ stdout pipe

ProcStderr

Actively-transmitted stderr as part of running process

Fields

id: ProcessId

Arbitrary id associated with running process

data: Vec<u8>

Data read from a process’ stderr pipe

ProcDone

Response to a process finishing

Fields

id: ProcessId

Arbitrary id associated with running process

success: bool

Whether or not termination was successful

code: Option<i32>

Exit code associated with termination, will be missing if terminated by signal

SystemInfo(SystemInfo)

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

Version(Version)

Response to retrieving information about the server’s version

Implementations

impl Response

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 Response

fn as_ref(&self) -> &str

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

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'_enum> From<&'_enum Response> for ResponseKind

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

Converts to this type from the input type.

impl From<Error> for Response

fn from(x: Error) -> Self

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

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Response

impl StructuralPartialEq for Response