Config

Struct Config 

Source
pub struct Config {
    pub region: String,
    pub endpoint: String,
    pub disable_ssl: bool,
    pub credentials: Credentials,
}
Expand description

Represents the configuration settings required for connecting to Volcengine services.

The Config struct holds essential parameters such as the service region, endpoint, SSL settings, and authentication credentials. It is designed to be used with a builder pattern (ConfigBuilder) to allow flexible and structured configuration.

§Fields

  • region (String): Specifies the geographical region for the service.
  • endpoint (String): The base URL of the API service. If manually set, this overrides the default endpoint.
  • disable_ssl (bool): Determines whether SSL/TLS is disabled.
    • true: SSL is disabled (not recommended for production).
    • false: SSL is enabled for secure communication.
  • credentials (credentials::Credentials): Stores authentication credentials, including access keys and secret keys, required for making API requests.

§Example

let config = Config {
    region: "us-west-2".to_string(),
    endpoint: "https://api.volcengine.com".to_string(),
    disable_ssl: false,
    credentials: credentials::Credentials::new("access_key", "secret_key"),
};

Fields§

§region: String§endpoint: String§disable_ssl: bool§credentials: Credentials

Implementations§

Source§

impl Config

Implementation of the Config struct, providing utility methods
for managing application configuration settings.

This implementation includes a builder method to facilitate
constructing a Config instance step-by-step using the ConfigBuilder.

§Key Functionalities
  • builder(): Returns a new ConfigBuilder instance with default values,
    allowing users to set configuration properties before building a Config object.

The Config struct encapsulates essential configuration parameters such as
service region, endpoint URL, SSL settings, and authentication credentials.
This implementation ensures that configuration objects are created in
a structured and validated manner.

Source

pub fn builder() -> ConfigBuilder

Creates a new ConfigBuilder instance to facilitate the construction of a Config object.

This method returns a ConfigBuilder with default values, allowing users to configure the settings step by step before building a complete Config instance.

§Example
let builder = Config::builder();

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,