Struct S2Endpoints 

#[non_exhaustive]
pub struct S2Endpoints { /* private fields */ }

Endpoints for the S2 environment.

Implementations

impl S2Endpoints

pub fn new( account_endpoint: AccountEndpoint, basin_endpoint: BasinEndpoint, ) -> Result<Self, ValidationError>

Create a new S2Endpoints with the given account and basin endpoints.

Examples found in repository

examples/docs_configuration.rs (lines 17-20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Example: Custom endpoints (e.g., for s2-lite local dev)
    {
        // ANCHOR: custom-endpoints
        let client = S2::new(
            S2Config::new("local-token").with_endpoints(S2Endpoints::new(
                AccountEndpoint::new("http://localhost:8080")?,
                BasinEndpoint::new("http://localhost:8080")?,
            )?),
        )?;
        // ANCHOR_END: custom-endpoints
        println!("Created client with custom endpoints: {:?}", client);
    }

    // Example: Custom retry configuration
    {
        let access_token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: retry-config
        let client = S2::new(
            S2Config::new(access_token).with_retry(
                RetryConfig::new()
                    .with_max_attempts(NonZeroU32::new(5).unwrap())
                    .with_min_base_delay(Duration::from_millis(100))
                    .with_max_base_delay(Duration::from_secs(2)),
            ),
        )?;
        // ANCHOR_END: retry-config
        println!("Created client with retry config: {:?}", client);
    }

    // Example: Custom timeout configuration
    {
        let access_token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: timeout-config
        let client = S2::new(
            S2Config::new(access_token)
                .with_connection_timeout(Duration::from_secs(5))
                .with_request_timeout(Duration::from_secs(10)),
        )?;
        // ANCHOR_END: timeout-config
        println!("Created client with timeout config: {:?}", client);
    }

    Ok(())
}

pub fn from_env() -> Result<Self, ValidationError>

Create a new S2Endpoints from environment variables.

The following environment variables are expected to be set:

• S2_ACCOUNT_ENDPOINT - Account-level endpoint.
• S2_BASIN_ENDPOINT - Basin-level endpoint.

Trait Implementations

impl Clone for S2Endpoints

fn clone(&self) -> S2Endpoints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for S2Endpoints

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

Formats the value using the given formatter.