Struct Client 

pub struct Client { /* private fields */ }

Client for interacting with the IC Object Store canister.

Handles communication with the canister and optional AES-256 encryption.

Fields

• agent: IC agent for making calls to the canister
• canister: Principal of the target canister
• cipher: Optional AES-256-GCM cipher for encryption/decryption

Implementations

impl Client

pub fn new( agent: Arc<Agent>, canister: Principal, aes_secret: Option<[u8; 32]>, ) -> Client

Creates a new Client instance with optional AES-256 encryption

Trait Implementations

impl CanisterCaller for Client

async fn canister_query<In: ArgumentEncoder + Send, Out: CandidType + for<'a> Deserialize<'a>>( &self, canister: &Principal, method: &str, args: In, ) -> Result<Out, BoxError>

Performs a query call to a canister (read-only, no state changes)

async fn canister_update<In: ArgumentEncoder + Send, Out: CandidType + for<'a> Deserialize<'a>>( &self, canister: &Principal, method: &str, args: In, ) -> Result<Out, BoxError>

Performs an update call to a canister (may modify state)

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl ObjectStoreSDK for Client

fn canister(&self) -> &Principal

fn cipher(&self) -> Option<Arc<Aes256Gcm>>

fn get_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<StateInfo, String>> + Send + 'async_trait>>

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

Retrieves the current state of the object store

fn is_member<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, member_kind: &'life1 str, user: &'life2 Principal, ) -> Pin<Box<dyn Future<Output = Result<bool, String>> + Send + 'async_trait>>

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

fn admin_add_managers<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 BTreeSet<Principal>, ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'async_trait>>

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

Adds managers to the canister (requires controller privileges)

fn admin_remove_managers<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 BTreeSet<Principal>, ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'async_trait>>

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

Removes managers from the canister (requires controller privileges)

fn admin_add_auditors<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 BTreeSet<Principal>, ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'async_trait>>

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

Adds auditors to the canister (requires controller privileges)

fn admin_remove_auditors<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 BTreeSet<Principal>, ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'async_trait>>

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

Removes auditors from the canister (requires controller privileges)

fn put_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, payload: &'life2 Bytes, opts: PutOptions, ) -> Pin<Box<dyn Future<Output = Result<PutResult>> + Send + 'async_trait>>

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

Stores data at specified path with options

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Deletes data at specified path

fn copy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Copies data from one path to another

fn copy_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Copies data only if destination doesn’t exist

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Renames/moves data from one path to another

fn rename_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Renames/moves data only if destination doesn’t exist

fn create_multipart<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<MultipartId>> + Send + 'async_trait>>

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

Initiates a multipart upload

fn put_part<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, path: &'life1 Path, id: &'life2 MultipartId, part_idx: u64, payload: &'life3 Bytes, ) -> Pin<Box<dyn Future<Output = Result<PartId>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Uploads a part in a multipart upload

fn complete_multipart<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, path: &'life1 Path, id: &'life2 MultipartId, opts: &'life3 PutMultipartOptions, ) -> Pin<Box<dyn Future<Output = Result<PutResult>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Completes a multipart upload

fn abort_multipart<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, id: &'life2 MultipartId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Aborts a multipart upload

fn get_part<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, part_idx: u64, ) -> Pin<Box<dyn Future<Output = Result<ByteBuf>> + Send + 'async_trait>>

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

Retrieves a specific part of data

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, opts: GetOptions, ) -> Pin<Box<dyn Future<Output = Result<GetResult>> + Send + 'async_trait>>

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

Retrieves data with options (range, if_match, etc.)

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, ranges: &'life2 [(u64, u64)], ) -> Pin<Box<dyn Future<Output = Result<Vec<ByteBuf>>> + Send + 'async_trait>>

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

Retrieves multiple ranges of data

fn head<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<ObjectMeta>> + Send + 'async_trait>>

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

Retrieves metadata for a path

fn list<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObjectMeta>>> + Send + 'async_trait>>

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

Lists objects under a prefix

fn list_with_offset<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, offset: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObjectMeta>>> + Send + 'async_trait>>

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

Lists objects with an offset

fn list_with_delimiter<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, ) -> Pin<Box<dyn Future<Output = Result<ListResult>> + Send + 'async_trait>>

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

Lists objects with directory delimiter