Struct SDK 

pub struct SDK { /* private fields */ }

Implementations

impl SDK

pub fn app_key(&self) -> &PrivateKey

Returns the application key used by the SDK.

This should be kept secret and secure. Applications should store it safely.

pub async fn upload<R: AsyncReadExt + Unpin + Send + 'static>( &self, reader: R, options: UploadOptions, ) -> Result<Object, UploadError>

Reads until EOF and uploads all slabs. The data will be erasure coded, encrypted, and uploaded using the uploader’s parameters.

Arguments

• r - The reader to read the data from. It will be read until EOF.
• options - The UploadOptions to use for the upload.

Returns

A new object containing the metadata needed to download the object. The object can be sealed and pinned to the indexer when ready.

pub fn upload_packed(&self, options: UploadOptions) -> PackedUpload

Creates a new packed upload. This allows multiple objects to be packed together for more efficient uploads. The returned PackedUpload can be used to add objects to the upload, and then finalized to get the resulting objects.

Arguments

• options - The UploadOptions to use for the upload.

Returns

A PackedUpload that can be used to add objects and finalize the upload.

pub async fn download<W: AsyncWriteExt + Unpin>( &self, w: &mut W, object: &Object, options: DownloadOptions, ) -> Result<(), DownloadError>

Downloads an object using the provided writer and options.

pub async fn hosts(&self, query: HostQuery) -> Result<Vec<Host>, Error>

Retrieves a list of hosts from the indexer matching the provided query that can be used for uploading and downloading data.

Arguments

• query - Filtering criteria to select hosts.

pub async fn account(&self) -> Result<Account, Error>

Retrieves account information from the indexer.

pub async fn object(&self, key: &Hash256) -> Result<Object, Error>

Retrieves an object from the indexer by its key.

Arguments

• key - The key of the object to retrieve.

pub async fn object_events( &self, cursor: Option<ObjectsCursor>, limit: Option<usize>, ) -> Result<Vec<ObjectEvent>, Error>

Retrieves a list of object events from the indexer. This can be used to synchronize local state with the indexer.

Arguments

• cursor - An optional cursor to continue from a previous call.
• limit - An optional limit on the number of events to retrieve.

pub async fn prune_slabs(&self) -> Result<(), Error>

Prunes unused slabs from the indexer. This helps to free up storage space by removing slabs that are no longer referenced by objects.

pub async fn update_object_metadata(&self, object: &Object) -> Result<(), Error>

Updates the metadata of an object in the indexer. The object must already be pinned to the indexer.

Arguments

• object - The object to update.

pub async fn delete_object(&self, id: &Hash256) -> Result<(), Error>

Deletes the object with the given id.

Arguments

• id - The id of the object to delete.

pub fn share_object( &self, object: &Object, valid_until: DateTime<Utc>, ) -> Result<Url, Error>

Generates a shared URL for the given object that is valid until the specified time.

This object should be considered public even if the URL is kept secret, as anyone with the URL can access the object until the expiration time.

Arguments

• object - The object to share.
• valid_until - The time until which the shared URL is valid.

pub async fn shared_object<U: IntoUrl>( &self, share_url: U, ) -> Result<Object, Error>

Retrieves a shared object from the given share URL.

Arguments

• share_url - The URL of the shared object.

pub async fn pin_object(&self, object: &Object) -> Result<(), Error>

Pins an object to the indexer

pub async fn slab(&self, id: &Hash256) -> Result<PinnedSlab, Error>

Retrieves a pinned slab from the indexer by its id.

Trait Implementations

impl Clone for SDK

fn clone(&self) -> SDK

Returns a duplicate of the value.

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

Performs copy-assignment from source.