Trait distant_core::DistantChannelExt

source · [−]
pub trait DistantChannelExt {

Show 19 methods    fn append_file(
        &mut self,
        path: impl Into<PathBuf>,
        data: impl Into<Vec<u8>>
    ) -> AsyncReturn<'_, ()>;
    fn append_file_text(
        &mut self,
        path: impl Into<PathBuf>,
        data: impl Into<String>
    ) -> AsyncReturn<'_, ()>;
    fn copy(
        &mut self,
        src: impl Into<PathBuf>,
        dst: impl Into<PathBuf>
    ) -> AsyncReturn<'_, ()>;
    fn create_dir(
        &mut self,
        path: impl Into<PathBuf>,
        all: bool
    ) -> AsyncReturn<'_, ()>;
    fn exists(&mut self, path: impl Into<PathBuf>) -> AsyncReturn<'_, bool>;
    fn metadata(
        &mut self,
        path: impl Into<PathBuf>,
        canonicalize: bool,
        resolve_file_type: bool
    ) -> AsyncReturn<'_, Metadata>;
    fn read_dir(
        &mut self,
        path: impl Into<PathBuf>,
        depth: usize,
        absolute: bool,
        canonicalize: bool,
        include_root: bool
    ) -> AsyncReturn<'_, (Vec<DirEntry>, Vec<Failure>)>;
    fn read_file(&mut self, path: impl Into<PathBuf>) -> AsyncReturn<'_, Vec<u8>>;
    fn read_file_text(
        &mut self,
        path: impl Into<PathBuf>
    ) -> AsyncReturn<'_, String>;
    fn remove(
        &mut self,
        path: impl Into<PathBuf>,
        force: bool
    ) -> AsyncReturn<'_, ()>;
    fn rename(
        &mut self,
        src: impl Into<PathBuf>,
        dst: impl Into<PathBuf>
    ) -> AsyncReturn<'_, ()>;
    fn watch(
        &mut self,
        path: impl Into<PathBuf>,
        recursive: bool,
        only: impl Into<ChangeKindSet>,
        except: impl Into<ChangeKindSet>
    ) -> AsyncReturn<'_, Watcher>;
    fn unwatch(&mut self, path: impl Into<PathBuf>) -> AsyncReturn<'_, ()>;
    fn spawn(
        &mut self,
        cmd: impl Into<String>,
        environment: Environment,
        current_dir: Option<PathBuf>,
        persist: bool,
        pty: Option<PtySize>
    ) -> AsyncReturn<'_, RemoteProcess>;
    fn spawn_lsp(
        &mut self,
        cmd: impl Into<String>,
        environment: Environment,
        current_dir: Option<PathBuf>,
        persist: bool,
        pty: Option<PtySize>
    ) -> AsyncReturn<'_, RemoteLspProcess>;
    fn output(
        &mut self,
        cmd: impl Into<String>,
        environment: Environment,
        current_dir: Option<PathBuf>,
        pty: Option<PtySize>
    ) -> AsyncReturn<'_, RemoteOutput>;
    fn system_info(&mut self) -> AsyncReturn<'_, SystemInfo>;
    fn write_file(
        &mut self,
        path: impl Into<PathBuf>,
        data: impl Into<Vec<u8>>
    ) -> AsyncReturn<'_, ()>;
    fn write_file_text(
        &mut self,
        path: impl Into<PathBuf>,
        data: impl Into<String>
    ) -> AsyncReturn<'_, ()>;

}
Expand description

Provides convenience functions on top of a [SessionChannel]

Required Methods

Appends to a remote file using the data from a collection of bytes

source

fn append_file_text(
    &mut self,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> AsyncReturn<'_, ()>

Appends to a remote file using the data from a string

Copies a remote file or directory from src to dst

Creates a remote directory, optionally creating all parent components if specified

Retrieves metadata about a path on a remote machine

Reads entries from a directory, returning a tuple of directory entries and failures

Reads a remote file as a collection of bytes

source

fn read_file_text(&mut self, path: impl Into<PathBuf>) -> AsyncReturn<'_, String>

Returns a remote file as a string

Removes a remote file or directory, supporting removal of non-empty directories if force is true

Renames a remote file or directory from src to dst

Watches a remote file or directory

Unwatches a remote file or directory

Spawns a process on the remote machine

Spawns an LSP process on the remote machine

Spawns a process on the remote machine and wait for it to complete

Retrieves information about the remote system

Writes a remote file with the data from a collection of bytes

source

fn write_file_text(
    &mut self,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> AsyncReturn<'_, ()>

Writes a remote file with the data from a string

Implementations on Foreign Types

source

fn append_file_text(
    &mut self,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> AsyncReturn<'_, ()>

source

fn read_file_text(&mut self, path: impl Into<PathBuf>) -> AsyncReturn<'_, String>

source

fn write_file_text(
    &mut self,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> AsyncReturn<'_, ()>

Implementors