Struct FileServiceClient 

pub struct FileServiceClient { /* private fields */ }

Client for an active fileservice session.

Implementations

impl FileServiceClient

pub async fn connect( control: XpcClient, domain: Domain, identifier: impl AsRef<str>, ) -> Result<Self, FileServiceError>

Create a new fileservice session in the requested domain.

pub fn with_session(control: XpcClient, session_id: impl Into<String>) -> Self

Build a client from an existing session ID.

pub fn session_id(&self) -> &str

Return the CoreDevice session identifier.

pub async fn list_directory( &mut self, path: &str, ) -> Result<Vec<String>, FileServiceError>

List child names for path within the active session domain.

pub async fn retrieve_file_ticket( &mut self, path: &str, ) -> Result<FileTransferTicket, FileServiceError>

Request a data-plane ticket for downloading path.

pub async fn download_file<S>( &mut self, path: &str, data_stream: &mut S, ) -> Result<Bytes, FileServiceError>

where S: AsyncRead + AsyncWrite + Unpin,

Download path into memory through the data service stream.

pub async fn download_file_to_writer<S, W>( &mut self, path: &str, data_stream: &mut S, writer: &mut W, ) -> Result<u64, FileServiceError>

where S: AsyncRead + AsyncWrite + Unpin, W: AsyncWrite + Unpin,

Download path directly into an async writer through the data service stream.

pub async fn propose_empty_file( &mut self, path: &str, options: FileWriteOptions, ) -> Result<(), FileServiceError>

Create an empty remote file with the supplied metadata.

pub async fn remove_item( &mut self, path: &str, recursive: bool, ) -> Result<(), FileServiceError>

Remove a remote item.

Set recursive for directories. The device enforces the permissions of the selected session domain.

pub async fn create_directory( &mut self, path: &str, options: FileWriteOptions, ) -> Result<(), FileServiceError>

Create a directory with the supplied metadata.

pub async fn rename_item( &mut self, from: &str, to: &str, ) -> Result<(), FileServiceError>

Rename or move an item within the active session domain.

pub async fn upload_inline_file( &mut self, path: &str, data: Bytes, options: FileWriteOptions, ) -> Result<(), FileServiceError>

Upload a small file by embedding its bytes in the control-plane request.

pub async fn propose_file_upload( &mut self, path: &str, file_size: u64, options: FileWriteOptions, ) -> Result<FileTransferTicket, FileServiceError>

Request a data-plane upload ticket for a large file.

pub async fn upload_file_data<S, R>( &mut self, data_stream: &mut S, ticket: &FileTransferTicket, reader: &mut R, file_size: u64, ) -> Result<(), FileServiceError>

where S: AsyncRead + AsyncWrite + Unpin, R: AsyncRead + Unpin,

Stream large file bytes to the data service using a previously issued ticket.