Struct S2Endpoints 

#[non_exhaustive]
pub struct S2Endpoints {
    pub scheme: Scheme,
    pub account_authority: Authority,
    pub basin_authority: BasinAuthority,
}

Endpoints for the S2 environment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scheme: Scheme

URI scheme.

Defaults to https.

account_authority: Authority

Account authority.

basin_authority: BasinAuthority

Basin authority.

Implementations

impl S2Endpoints

pub fn new( account_authority: Authority, basin_authority: BasinAuthority, ) -> Self

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

Examples found in repository

examples/docs_configuration.rs (lines 18-21)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Example: Custom endpoints (e.g., for s2-lite local dev)
    {
        let token = "local-token".to_string();
        // ANCHOR: custom-endpoints
        let endpoints = S2Endpoints::new(
            "localhost:8080".parse()?,
            BasinAuthority::Direct("localhost:8080".parse()?),
        )
        .with_scheme(Scheme::HTTP);

        let client = S2::new(S2Config::new(token).with_endpoints(endpoints))?;
        // ANCHOR_END: custom-endpoints
        println!("Created client with custom endpoints: {:?}", client);
    }

    // Example: Custom retry configuration
    {
        let token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: retry-config
        let client = S2::new(
            S2Config::new(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 token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: timeout-config
        let client = S2::new(
            S2Config::new(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.

pub fn with_scheme(self, scheme: Scheme) -> Self

Set the URI scheme.

Examples found in repository

examples/docs_configuration.rs (line 22)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Example: Custom endpoints (e.g., for s2-lite local dev)
    {
        let token = "local-token".to_string();
        // ANCHOR: custom-endpoints
        let endpoints = S2Endpoints::new(
            "localhost:8080".parse()?,
            BasinAuthority::Direct("localhost:8080".parse()?),
        )
        .with_scheme(Scheme::HTTP);

        let client = S2::new(S2Config::new(token).with_endpoints(endpoints))?;
        // ANCHOR_END: custom-endpoints
        println!("Created client with custom endpoints: {:?}", client);
    }

    // Example: Custom retry configuration
    {
        let token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: retry-config
        let client = S2::new(
            S2Config::new(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 token = std::env::var("S2_ACCESS_TOKEN").unwrap_or_else(|_| "demo".into());
        // ANCHOR: timeout-config
        let client = S2::new(
            S2Config::new(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(())
}

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.