Struct SataClient 

pub struct SataClient { /* private fields */ }

Available on crate feature clients only.

A connection to a sata pcfs server.

Implementations

impl SataClient

pub async fn connect<AddrTy: ToSocketAddrs>( address: AddrTy, supports_csr: bool, supports_ffio: bool, first_read_size: u32, first_write_size: u32, trace_io_during_debug: bool, ) -> Result<Self, CatBridgeError>

Connect to a PCFS Sata server.

Errors

This errors when the client cannot connect to the server.

pub async fn try_set_csr_ffio( &self, csr: bool, ffio: bool, ) -> Result<(), CatBridgeError>

Attempt to update Combined Send/Recv & Fast File I/O flags.

This may fail if setting to ‘true’, as both the server, and client have to support, and agree to these flags in order for them to be supported.

Errors

If we cannot negotiate with the server to update combined send/recv.

pub async fn try_set_csr(&self, csr: bool) -> Result<(), CatBridgeError>

Attempt to update combined send/recv flag or “CSR”.

This may fail if setting to ‘true’, as both the server, and client have to support, and agree to support Combined Send/Recv.

Errors

If we cannot negotiate with the server to update combined send/recv.

pub async fn try_set_ffio(&self, ffio: bool) -> Result<(), CatBridgeError>

Attempt to update fast-file i/o or “FFIO”.

This may fail if setting to ‘true’, as both the server, and client have to support, and agree to support FFIO.

Errors

If we cannot negotiate with the server to update combined send/recv.

pub async fn ping( &self, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Perform a ‘ping’ on the remote host, and update our CSR/FFIO flag state.

Errors

If we cannot send a request to our upstream PCFS server, or if we cannot read a response back in the timeout specified.

pub async fn change_mode( &self, path: String, writable: bool, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Mark a file as ‘read-only’, or ‘writable’.

In the future someday we may allow full change mode flags of unix-style flags. Unfortunately because this is based off of windows code you have only a read-only vs writable flag.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn change_owner( &self, path: String, owner: u32, group: u32, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Change the user owner, and group owner of a file.

NOTE(mythra): this will always error when talking with a PCFS compatible server.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn create_folder( &self, path: String, writable: bool, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Create a new folder on the remote PCFS server.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn info_by_query( &self, path: String, query_type: SataQueryType, timeout: Option<Duration>, ) -> Result<SataQueryResponse, CatBridgeError>

Query a particular path for information about it.

In general prefer more specific query types, as opposed to this particular “grab-bag” of an interface, which will safely wrap this function and choose the right kind of return type.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn file_count( &self, path: String, timeout: Option<Duration>, ) -> Result<u32, CatBridgeError>

Get the amount of files within a particular folder.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn free_disk_space( &self, path: String, timeout: Option<Duration>, ) -> Result<u64, CatBridgeError>

Get the amount of free disk space left on whatever disk the path is on.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn folder_size( &self, path: String, timeout: Option<Duration>, ) -> Result<u64, CatBridgeError>

Get the total amount of space being taken by a folder.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn path_info( &self, path: String, timeout: Option<Duration>, ) -> Result<SataFDInfo, CatBridgeError>

Get the information about a particular file path.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn remove( &self, path: String, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Remove a file or folder on the host filesystem.

Errors

• If the path name is too long to be serialized.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

pub async fn open_file( &self, path: String, mode_string: String, timeout: Option<Duration>, ) -> Result<SataClientFileHandle<'_>, CatBridgeError>

Attempt to open a file on the remote host.

This will return a file handle that you can then call read, write, etc. on. You will have to call close() on the file handle specifically.

Errors

• If the path name is too long to be serialized.
• If the mode setring is not formatted correctly.
• If we cannot send the request to the PCFS Sata server.
• If we cannot receive a response from the PCFS Sata server.
• If we cannot parse the response from the PCFS Sata server.
• If the return code of the response was not successful.

Trait Implementations

impl Debug for SataClient

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

Formats the value using the given formatter.

impl Structable for SataClient

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl Valuable for SataClient

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.