Struct ConfigBuilder 

pub struct ConfigBuilder { /* private fields */ }

A builder for constructing a Config instance in a structured manner.

The ConfigBuilder struct allows users to set configuration parameters individually, ensuring required fields are provided before building the final Config instance.

Fields

• region (Option<String>): Optional region value.
• endpoint (Option<String>): Optional endpoint value.
• disable_ssl (Option<bool>): Optional SSL flag.
• credentials (Option<credentials::Credentials>): Optional authentication credentials.

Implementations

impl ConfigBuilder

Implementation of the ConfigBuilder struct, which provides a fluent interface
for constructing a Config instance step-by-step.

The builder pattern allows for greater flexibility when creating configuration objects
by enabling method chaining to set individual parameters. This approach ensures
that required fields are validated before the final Config instance is created.

Example Usage

use crate::volcengine::config::Config;  
  
let config = Config::builder()  
    .with_region("us-east-1")  
    .with_endpoint("https://example.com")  
    .with_disable_ssl(true)  
    .with_credentials(credentials)  
    .build()  
    .expect("Failed to build config");  

Each setter method in ConfigBuilder accepts an argument, modifies the corresponding
field, and returns self to allow method chaining. The build method performs final
validation and returns a Config instance or an error if mandatory fields are missing.

pub fn with_region(self, region: &str) -> Self

Sets the region for the configuration.

Arguments

• region (&str): The service region to be set.

Returns

• Self: The updated ConfigBuilder instance with the specified region.

pub fn with_endpoint(self, endpoint: &str) -> Self

Sets the endpoint URL for the configuration.

Arguments

• endpoint (&str): The service endpoint to be set.

Returns

• Self: The updated ConfigBuilder instance with the specified endpoint.

pub fn with_disable_ssl(self, disable_ssl: bool) -> Self

Enables or disables SSL in the configuration.

Arguments

• disable_ssl (bool): Set to true to disable SSL, or false to enable it.

Returns

• Self: The updated ConfigBuilder instance with the specified SSL setting.

pub fn with_credentials(self, credentials: Credentials) -> Self

Sets the credentials for the configuration.

Arguments

• credentials (credentials::Credentials): Authentication credentials.

Returns

• Self: The updated ConfigBuilder instance with the specified credentials.

pub fn build(self) -> Result<Config, Error>

Builds the final Config object.

This method ensures that all required fields (such as credentials) are provided before constructing the Config instance. If any required field is missing, an error is returned.

Returns

• Ok(Config): The successfully built Config instance.
• Err(error::Error): Returns an error if required fields (e.g., credentials) are missing.

Example

let config = Config::builder()
    .with_region("us-west-2")
    .with_endpoint("https://api.volcengine.com")
    .with_disable_ssl(false)
    .with_credentials(credentials::Credentials::new("access_key", "secret_key"))
    .build();

match config {
    Ok(cfg) => println!("Configuration built successfully!"),
    Err(err) => println!("Failed to build configuration: {:?}", err),
}

Trait Implementations

impl Default for ConfigBuilder

Provides a default implementation for ConfigBuilder,
initializing all fields to None.

This implementation ensures that when a ConfigBuilder instance is created
without any parameters, it starts with no predefined values. The user can
then set specific fields as needed before calling build().

Default Values

• region: None (must be provided if required for the configuration)
• endpoint: None (must be provided if required for the configuration)
• disable_ssl: None (defaults to false if not explicitly set)
• credentials: None (mandatory; build() will return an error if not provided)

Using the builder pattern with a default constructor allows flexibility
while enforcing validation rules in the build() method.

fn default() -> Self

Returns the “default value” for a type.