Struct ReductClient

Help

pub struct ReductClient { /* private fields */ }

Expand description

ReductStore client.

Implementations§

Source §

impl ReductClient

Source

pub fn builder() -> ReductClientBuilder

Create a new ReductClientBuilder.

§Examples

use reduct_rs::ReductClient;

let client = ReductClient::builder()
   .set_url("https://reductstore.com")
   .set_api_token("my-api-token")
   .build();

Source

pub fn url(&self) -> &str

Get the URL of the ReductStore instance.

Source

pub fn api_token(&self) -> &str

Get the API token.

Source

pub async fn server_info(&self) -> Result<ServerInfo, ReductError>

Get the server info.

§Returns

The server info

Source

pub async fn bucket_list(&self) -> Result<BucketInfoList, ReductError>

Get the bucket list.

§Returns

The bucket list.

Source

pub fn create_bucket(&self, name: &str) -> BucketBuilder

Create a bucket.

§Arguments

name - The name of the bucket

§Returns

a bucket builder to set the bucket settings

Source

pub async fn get_bucket(&self, name: &str) -> Result<Bucket, ReductError>

Get a bucket.

§Arguments

name - The name of the bucket

§Returns

the bucket or an error

Source

pub async fn alive(&self) -> Result<(), ReductError>

Check if the server is alive.

§Returns

Ok if the server is alive, otherwise an error.

Source

pub async fn me(&self) -> Result<Token, ReductError>

Get the token with permissions for the current user.

§Returns

The token or HttpError

Source

pub async fn create_token( &self, name: &str, permissions: Permissions, ) -> Result<String, ReductError>

Create an access token

§Arguments

name - The name of the token
permissions - The permissions of the token

§Returns

The token value or HttpError

Source

pub async fn get_token(&self, name: &str) -> Result<Token, ReductError>

Get an access token

§Arguments

name - The name of the token

§Returns

The token or an error

Source

pub async fn delete_token(&self, name: &str) -> Result<(), ReductError>

Delete an access token

§Arguments

name - The name of the token

§Returns

Ok if the token was deleted, otherwise an error

Source

pub async fn list_tokens(&self) -> Result<Vec<Token>, ReductError>

List all access tokens

§Returns

The list of tokens or an error

Source

pub async fn list_replications( &self, ) -> Result<Vec<ReplicationInfo>, ReductError>

Get list of replications

§Returns

The list of replications or an error

Source

pub async fn get_replication( &self, name: &str, ) -> Result<FullReplicationInfo, ReductError>

Get full replication info

§Arguments

name - The name of the replication

§Returns

The replication info or an error

Source

pub fn create_replication(&self, name: &str) -> ReplicationBuilder

Create a replication

§Arguments

name - The name of the replication

§Returns

a replication builder to set the replication settings

§Example

use reduct_rs::ReductClient;

#[tokio::main]
async fn main() {
    let client = ReductClient::builder()
        .url("http://127.0.0.1:8383")
        .api_token("my-api-token")
        .build();

    client.create_replication("test-replication")
        .src_bucket("test-bucket-1")
        .dst_bucket("test-bucket-2")
        .dst_host("https://play.reduct.store")
        .dst_token("reductstore")
        .send()
        .await
        .unwrap();
}