Struct Api 

pub struct Api { /* private fields */ }

Represents an implementation of DistantApi that works with the local machine where the server using this api is running. In other words, this is a direct impementation of the API instead of a proxy to another machine as seen with implementations on top of SSH and other protocol.

Implementations

impl Api

pub fn initialize(config: Config) -> Result<Self>

Initialize the api instance

Trait Implementations

impl DistantApi for Api

fn read_file<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads bytes from a file.

fn read_file_text<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads bytes from a file as text.

fn write_file<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Writes bytes to a file, overwriting the file if it exists.

fn write_file_text<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, data: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Writes text to a file, overwriting the file if it exists.

fn append_file<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Writes bytes to the end of a file, creating it if it is missing.

fn append_file_text<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, data: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Writes bytes to the end of a file, creating it if it is missing.

fn read_dir<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, depth: usize, absolute: bool, canonicalize: bool, include_root: bool, ) -> Pin<Box<dyn Future<Output = Result<(Vec<DirEntry>, Vec<Error>)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads entries from a directory.

fn create_dir<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, all: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a directory.

fn remove<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, force: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes some file or directory.

fn copy<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, src: PathBuf, dst: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Copies some file or directory.

fn rename<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, src: PathBuf, dst: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Renames some file or directory.

fn watch<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, recursive: bool, only: Vec<ChangeKind>, except: Vec<ChangeKind>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Watches a file or directory for changes.

fn unwatch<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes a file or directory from being watched.

fn exists<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks if the specified path exists.

fn metadata<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, path: PathBuf, canonicalize: bool, resolve_file_type: bool, ) -> Pin<Box<dyn Future<Output = Result<Metadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads metadata for a file or directory.

fn set_permissions<'life0, 'async_trait>( &'life0 self, _ctx: DistantCtx, path: PathBuf, permissions: Permissions, options: SetPermissionsOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets permissions for a file, directory, or symlink.

fn search<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, query: SearchQuery, ) -> Pin<Box<dyn Future<Output = Result<SearchId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Searches files for matches based on a query.

fn cancel_search<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, id: SearchId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Cancels an actively-ongoing search.

fn proc_spawn<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, cmd: String, environment: Environment, current_dir: Option<PathBuf>, pty: Option<PtySize>, ) -> Pin<Box<dyn Future<Output = Result<ProcessId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Spawns a new process, returning its id.

fn proc_kill<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, id: ProcessId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Kills a running process by its id.

fn proc_stdin<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, id: ProcessId, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends data to the stdin of the process with the specified id.

fn proc_resize_pty<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, id: ProcessId, size: PtySize, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Resizes the PTY of the process with the specified id.

fn system_info<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, ) -> Pin<Box<dyn Future<Output = Result<SystemInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves information about the system.

fn version<'life0, 'async_trait>( &'life0 self, ctx: DistantCtx, ) -> Pin<Box<dyn Future<Output = Result<Version>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves information about the server’s capabilities.

fn on_connect<'life0, 'async_trait>( &'life0 self, id: u32, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Invoked whenever a new connection is established.

fn on_disconnect<'life0, 'async_trait>( &'life0 self, id: u32, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Invoked whenever an existing connection is dropped.