Struct Builder

pub struct Builder { /* private fields */ }

Builder for creating a new Operator instance.

Example

use cf_r2_sdk::builder::Builder;
use cf_r2_sdk::error::Error;
use dotenvy::dotenv;
use std::env;

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
   // load .env file
   dotenv().expect(".env file not found.");
   // insert a environment variable
   let bucket_name = env::var("BUCKET_NAME").expect("BUCKET_NAME not found in .env file.");
   let endpoint_url: String =
       env::var("ENDPOINT_URL").expect("ENDPOINT_URL not found in .env file.");
   let access_key_id: String =
       env::var("ACCESS_KEY_ID").expect("ACCESS_KEY_ID not found in .env file.");
   let secret_access_key: String =
      env::var("SECRET_ACCESS_KEY").expect("SECRET_ACCESS_KEY not found in .env file.");
   let region: String = env::var("REGION").expect("REGION not found in .env file.");

   let object: cf_r2_sdk::operator::Operator = Builder::new()
       .set_bucket_name(bucket_name)
       .set_access_key_id(access_key_id)
       .set_secret_access_key(secret_access_key)
       .set_endpoint(endpoint_url)
       .set_region(region)
       .create_client_result()?;
   Ok(())
}

Implementations

impl Builder

pub fn new() -> Self

Create a new Builder instance with default values.

default value of region is “auto”.

pub fn set_bucket_name(self, bucket_name: String) -> Self

Set the bucket name.

pub fn set_access_key_id(self, access_key_id: String) -> Self

Set the access key id.

pub fn set_secret_access_key(self, secret_access_key: String) -> Self

Set the secret access key.

pub fn set_endpoint(self, endpoint: String) -> Self

Set the endpoint.

pub fn set_region(self, region: String) -> Self

Set the region.

pub fn create_client(&self) -> Operator

👎Deprecated since 3.1.0: use create_client_result() instead

Create a new Operator instance.

pub fn create_client_result(&self) -> Result<Operator, BuilderError>

Create a new Operator instance.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.