Struct BasinEndpoint 

pub struct BasinEndpoint { /* private fields */ }

Basin endpoint.

Implementations

impl BasinEndpoint

pub fn new(endpoint: &str) -> Result<Self, ValidationError>

Create a new BasinEndpoint with the given endpoint.

Examples found in repository

examples/docs_configuration.rs (line 19)

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(
            AccountEndpoint::new("http://localhost:8080")?,
            BasinEndpoint::new("http://localhost:8080")?,
        )?;

        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 BasinEndpoint

fn clone(&self) -> BasinEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasinEndpoint

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

Formats the value using the given formatter.

impl FromStr for BasinEndpoint

type Err = ValidationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.