Struct SataClientFileHandle 

pub struct SataClientFileHandle<'client> { /* private fields */ }

Available on crate feature clients only.

A file that is actively open on an existing sata client.

This is called with SataClient::open_file, and ensures that methods like “reading a file”, can only ever be done on an open file handle.

Implementations

impl SataClientFileHandle<'_>

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

Close this file, and ensure it can’t be used anymore.

Errors

• 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 read_file( &self, amount: usize, move_to: Option<MoveToFileLocation>, timeout: Option<Duration>, ) -> Result<(usize, Bytes), CatBridgeError>

Read N amounts of bytes from a file.

You can optionally move the file pointer around before doing the read. This will return the total file length, along with the bytes that you actually read.

Errors

• 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 stat( &self, timeout: Option<Duration>, ) -> Result<SataFDInfo, CatBridgeError>

Get information about the current open file.

Errors

• 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 move_to( &self, move_to: MoveToFileLocation, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Move to a new location within this file.

Errors

• 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 write_file( &self, to_write: Bytes, move_to: Option<MoveToFileLocation>, timeout: Option<Duration>, ) -> Result<(), CatBridgeError>

Write N amounts of bytes from a file.

You can optionally move the file pointer around before doing the write.

note: in cases of extreme latency a file write may succeed, but reutrn failure because we could not parse the response in the timeout.

Errors

• 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<'client> Debug for SataClientFileHandle<'client>

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

Formats the value using the given formatter.

impl<'client> Structable for SataClientFileHandle<'client>

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

Returns the struct’s definition.

impl<'client> Valuable for SataClientFileHandle<'client>

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.