Struct distant_core::SessionChannel

pub struct SessionChannel { /* private fields */ }

Represents a sender of requests tied to a session, holding onto a weak reference of mailboxes to relay responses, meaning that once the Session is closed or dropped, any sent request will no longer be able to receive responses

Implementations

impl SessionChannel

pub fn is_closed(&self) -> bool

Returns true if no more requests can be transferred

pub async fn mail(&mut self, req: Request) -> Result<Mailbox, TransportError>

Sends a request and returns a mailbox that can receive one or more responses, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

pub async fn send(&mut self, req: Request) -> Result<Response, TransportError>

Sends a request and waits for a response, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

pub async fn send_timeout(
    &mut self,
    req: Request,
    duration: Duration
) -> Result<Response, TransportError>

Sends a request and waits for a response, timing out after duration has passed

pub async fn fire(&mut self, req: Request) -> Result<(), TransportError>

Sends a request without waiting for a response; this method is able to be used even if the session’s receiving line to the remote server has been severed

pub async fn fire_timeout(
    &mut self,
    req: Request,
    duration: Duration
) -> Result<(), TransportError>

Sends a request without waiting for a response, timing out after duration has passed

Trait Implementations

impl Clone for SessionChannel

fn clone(&self) -> SessionChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Session> for SessionChannel

fn from(session: Session) -> Self

Converts to this type from the input type.

impl SessionChannelExt for SessionChannel

fn append_file(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    data: impl Into<Vec<u8>>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

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

fn append_file_text(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

Appends to a remote file using the data from a string

fn copy(
    &mut self,
    tenant: impl Into<String>,
    src: impl Into<PathBuf>,
    dst: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

Copies a remote file or directory from src to dst

fn create_dir(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    all: bool
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

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

fn exists(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<bool, SessionChannelExtError>> + Send + '_>>

Checks if a path exists on a remote machine

fn metadata(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    canonicalize: bool,
    resolve_file_type: bool
) -> Pin<Box<dyn Future<Output = Result<Metadata, SessionChannelExtError>> + Send + '_>>

Retrieves metadata about a path on a remote machine

fn read_dir(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    depth: usize,
    absolute: bool,
    canonicalize: bool,
    include_root: bool
) -> Pin<Box<dyn Future<Output = Result<(Vec<DirEntry>, Vec<Failure>), SessionChannelExtError>> + Send + '_>>

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

fn read_file(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, SessionChannelExtError>> + Send + '_>>

Reads a remote file as a collection of bytes

fn read_file_text(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<String, SessionChannelExtError>> + Send + '_>>

Returns a remote file as a string

fn remove(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    force: bool
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

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

fn rename(
    &mut self,
    tenant: impl Into<String>,
    src: impl Into<PathBuf>,
    dst: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

Renames a remote file or directory from src to dst

fn watch(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    recursive: bool,
    only: impl Into<ChangeKindSet>,
    except: impl Into<ChangeKindSet>
) -> Pin<Box<dyn Future<Output = Result<Watcher, WatchError>> + Send + '_>>

Watches a remote file or directory

fn unwatch(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>
) -> Pin<Box<dyn Future<Output = Result<(), UnwatchError>> + Send + '_>>

Unwatches a remote file or directory

fn spawn(
    &mut self,
    tenant: impl Into<String>,
    cmd: impl Into<String>,
    args: Vec<impl Into<String>>,
    persist: bool,
    pty: Option<PtySize>
) -> Pin<Box<dyn Future<Output = Result<RemoteProcess, RemoteProcessError>> + Send + '_>>

Spawns a process on the remote machine

fn spawn_lsp(
    &mut self,
    tenant: impl Into<String>,
    cmd: impl Into<String>,
    args: Vec<impl Into<String>>,
    persist: bool,
    pty: Option<PtySize>
) -> Pin<Box<dyn Future<Output = Result<RemoteLspProcess, RemoteProcessError>> + Send + '_>>

Spawns an LSP process on the remote machine

fn system_info(
    &mut self,
    tenant: impl Into<String>
) -> Pin<Box<dyn Future<Output = Result<SystemInfo, SessionChannelExtError>> + Send + '_>>

Retrieves information about the remote system

fn write_file(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    data: impl Into<Vec<u8>>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

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

fn write_file_text(
    &mut self,
    tenant: impl Into<String>,
    path: impl Into<PathBuf>,
    data: impl Into<String>
) -> Pin<Box<dyn Future<Output = Result<(), SessionChannelExtError>> + Send + '_>>

Writes a remote file with the data from a string