Struct ic_oss::bucket::Client

source ·
pub struct Client { /* private fields */ }

Implementations§

source§

impl Client

source

pub fn new(agent: Arc<Agent>, bucket: Principal) -> Client

source

pub fn set_chunk_size(&mut self, chunk_size: u32)

source

pub fn set_concurrency(&mut self, concurrency: u8)

source

pub async fn admin_set_managers( &self, args: BTreeSet<Principal>, ) -> Result<(), String>

the caller of agent should be canister controller

source

pub async fn admin_set_auditors( &self, args: BTreeSet<Principal>, ) -> Result<(), String>

the caller of agent should be canister controller

source

pub async fn admin_update_bucket( &self, args: UpdateBucketInput, ) -> Result<(), String>

the caller of agent should be canister controller

source

pub async fn get_bucket_info(&self) -> Result<BucketInfo, String>

source

pub async fn get_file_info(&self, id: u32) -> Result<FileInfo, String>

source

pub async fn get_file_info_by_hash( &self, hash: ByteN<32>, ) -> Result<FileInfo, String>

source

pub async fn get_file_ancestors( &self, id: u32, ) -> Result<Vec<FolderName>, String>

source

pub async fn get_file_chunks( &self, id: u32, index: u32, take: Option<u32>, ) -> Result<Vec<FileChunk>, String>

source

pub async fn list_files( &self, parent: u32, prev: Option<u32>, take: Option<u32>, ) -> Result<Vec<FileInfo>, String>

source

pub async fn get_folder_info(&self, id: u32) -> Result<FolderInfo, String>

source

pub async fn get_folder_ancestors( &self, id: u32, ) -> Result<Vec<FolderName>, String>

source

pub async fn list_folders(&self, parent: u32) -> Result<Vec<FolderInfo>, String>

source

pub async fn create_file( &self, file: CreateFileInput, ) -> Result<CreateFileOutput, String>

source

pub async fn update_file_chunk( &self, input: UpdateFileChunkInput, ) -> Result<UpdateFileChunkOutput, String>

source

pub async fn update_file_info( &self, input: UpdateFileInput, ) -> Result<UpdateFileOutput, String>

source

pub async fn move_file( &self, input: MoveInput, ) -> Result<UpdateFileOutput, String>

source

pub async fn delete_file(&self, id: u32) -> Result<bool, String>

source

pub async fn batch_delete_subfiles( &self, parent: u32, ids: BTreeSet<u32>, ) -> Result<Vec<u32>, String>

source

pub async fn create_folder( &self, input: CreateFolderInput, ) -> Result<CreateFolderOutput, String>

source

pub async fn update_folder_info( &self, input: UpdateFolderInput, ) -> Result<UpdateFolderOutput, String>

source

pub async fn move_folder( &self, input: MoveInput, ) -> Result<UpdateFolderOutput, String>

source

pub async fn delete_folder(&self, id: u32) -> Result<bool, String>

source

pub async fn upload<T, F>( &self, ar: T, file: CreateFileInput, progress: F, ) -> Result<UploadFileChunksResult, String>
where T: AsyncRead, F: Fn(usize),

source

pub async fn upload_chunks<T, F>( &self, ar: T, id: u32, exclude_chunks: &BTreeSet<u32>, progress: F, ) -> UploadFileChunksResult
where T: AsyncRead, F: Fn(usize),

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more