Struct Client 

pub struct Client { /* private fields */ }

The client, used for interacting witn a Menmos cluster.

Implementations

impl Client

pub async fn new<S: Into<String>, U: Into<String>, P: Into<String>>( directory_host: S, username: U, password: P, ) -> Result<Self, ClientError>

Create a new client from explicit credentials with default settings.

pub fn builder() -> ClientBuilder

Get a client builder to get better control on how the client is configured.

pub async fn register( &self, username: &str, password: &str, ) -> Result<String, ClientError>

pub async fn create_empty(&self, meta: Meta) -> Result<String, ClientError>

Create an empty file on the cluster with the provided meta.

Returns the created file’s ID.

pub async fn health(&self) -> Result<String, ClientError>

Send a health check request to the cluster.

Returns the cluster health status as a string.

pub async fn list_storage_nodes( &self, ) -> Result<ListStorageNodesResponse, ClientError>

List all storage nodes currently authenticated with the cluster.

pub async fn push<P: AsRef<Path>>( &self, path: P, meta: Meta, ) -> Result<String, ClientError>

Pushes a file with the specified meta to the cluster.

Returns the ID of the created file.

pub async fn update_blob<P: AsRef<Path>>( &self, blob_id: &str, path: P, meta: Meta, ) -> Result<String, ClientError>

Update a blob’s content.

Returns the ID of the updated file. Should always be equal to blob_id.

pub async fn list_meta( &self, tags: Option<Vec<String>>, meta_keys: Option<Vec<String>>, ) -> Result<MetadataList, ClientError>

Lists all metadata values in the cluster.

tags is an optional whitelist of tags to compute. When absent, all tags are included. meta_keys is an optional whitelist of keys to compute. When absent, all key/value pairs are included (this can be very expensive).

pub async fn update_meta( &self, blob_id: &str, meta: Meta, ) -> Result<(), ClientError>

Update a blob’s metadata without touching the contents of the file.

pub async fn fsync(&self, blob_id: &str) -> Result<(), ClientError>

Force synchronization of a blob to its backing storage.

This is an advanced feature, and should only be called by people who know what they are doing.

pub async fn write( &self, blob_id: &str, offset: u64, buffer: Bytes, ) -> Result<(), ClientError>

Write a byte buffer to a specified offset in a blob.

pub async fn get_meta( &self, blob_id: &str, ) -> Result<Option<BlobMeta>, ClientError>

Get a blob’s metadata.

pub async fn get_file( &self, blob_id: &str, ) -> Result<impl Stream<Item = Result<Bytes, ClientError>>, ClientError>

Get a blob’s body as a stream of bytes.

pub async fn read_range( &self, blob_id: &str, range: (u64, u64), ) -> Result<Vec<u8>, ClientError>

Read a subset of a blob.

The range argument is end-inclusive.

pub async fn query(&self, query: Query) -> Result<QueryResponse, ClientError>

Send a query to the cluster.

pub async fn delete(&self, blob_id: String) -> Result<(), ClientError>

Delete a blob from the cluster.

pub async fn get_routing_config( &self, ) -> Result<Option<RoutingConfig>, ClientError>

pub async fn set_routing_config( &self, routing_config: &RoutingConfig, ) -> Result<(), ClientError>

pub async fn delete_routing_config(&self) -> Result<(), ClientError>

Trait Implementations

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.