Skip to main content

ClientConfig

Struct ClientConfig 

Source
pub struct ClientConfig {
    pub base_url: String,
    pub api_key: String,
    pub management_token: String,
    pub delivery_token: String,
    pub environment: Option<String>,
    pub timeout: Duration,
    pub max_connections: usize,
    pub region: Region,
}
Expand description

Finalized configuration used by Contentstack clients.

This struct is typically constructed using ClientConfig::delivery or ClientConfig::management.

Fields§

§base_url: String

The base URL used for API requests.

§api_key: String

Your Contentstack stack API key.

§management_token: String

The token used for Management API authentication.

§delivery_token: String

The token used for Delivery API authentication.

§environment: Option<String>

The publishing environment (e.g., “production”). Only used by the Delivery API.

§timeout: Duration

The maximum duration to wait for a request to complete.

§max_connections: usize

The maximum number of concurrent connections allowed in the pool.

§region: Region

The geographical region for the API.

Implementations§

Source§

impl ClientConfig

Source

pub fn delivery( api_key: &str, delivery_token: &str, environment: &str, opts: Option<ClientOptions>, ) -> Self

Builds a ClientConfig configured for the Contentstack Delivery API.

Initializes a configuration object using the provided API key, delivery token, and environment. If opts is None, default settings are applied (AWS NA region, 30-second timeout, 50 max connections).

§Arguments
  • api_key - Your stack’s API key
  • delivery_token - Your stack’s delivery token (read-only)
  • environment - The name of the publishing environment
  • opts - Optional configuration overrides (ClientOptions)
§Examples
use contentstack_api_client_rs::client::config::ClientConfig;

let config = ClientConfig::delivery("api_key", "delivery_token", "production", None);
assert_eq!(config.environment.as_deref(), Some("production"));
Source

pub fn management( api_key: &str, management_token: &str, opts: Option<ClientOptions>, ) -> Self

Builds a ClientConfig for the Management API.

Defaults to AWS NA region (https://api.contentstack.io) if no base_url or region override is provided. Management API requests do not use an environment, so that field is left empty.

§Arguments
  • api_key - Your stack’s API key
  • management_token - Stack management token
  • opts - Optional configuration overrides (region, timeout, max connections)

Trait Implementations§

Source§

impl Clone for ClientConfig

Source§

fn clone(&self) -> ClientConfig

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 ClientConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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