Struct ClientConfig 

pub struct ClientConfig {
    pub base_url: String,
    pub token: String,
    pub dataset_id: Option<String>,
    pub timeout: Duration,
}

Configuration for RESO client

Holds all configuration needed to connect to a RESO Web API server, including the base URL, authentication token, optional dataset ID, and HTTP timeout settings.

Examples

// Create basic configuration
let config = ClientConfig::new(
    "https://api.mls.com/odata",
    "your-token"
);

// With dataset ID
let config = ClientConfig::new(
    "https://api.mls.com/odata",
    "your-token"
)
.with_dataset_id("actris_ref");

// With custom timeout
let config = ClientConfig::new(
    "https://api.mls.com/odata",
    "your-token"
)
.with_timeout(Duration::from_secs(60));

Fields

base_url: String

Base URL of the RESO Web API server

token: String

OAuth bearer token

dataset_id: Option<String>

Optional dataset ID (inserted between base_url and resource)

timeout: Duration

HTTP timeout duration

Implementations

impl ClientConfig

pub fn from_env() -> Result<Self>

Create configuration from environment variables

Expects:

• RESO_BASE_URL - Base URL of the RESO server (e.g., https://api.mls.com/api/v2/OData)
• RESO_TOKEN - OAuth bearer token
• RESO_DATASET_ID (optional) - Dataset ID inserted in URL path
• RESO_TIMEOUT (optional) - Timeout in seconds (default: 30)

Examples

// Reads RESO_BASE_URL, RESO_TOKEN, and optional variables from environment
let config = ClientConfig::from_env()?;

pub fn new(base_url: impl Into<String>, token: impl Into<String>) -> Self

Create configuration manually

Examples

let config = ClientConfig::new(
    "https://api.mls.com/odata",
    "your-bearer-token"
);

pub fn with_dataset_id(self, dataset_id: impl Into<String>) -> Self

Set dataset ID

Some RESO servers require a dataset identifier in the URL path. When set, URLs will be formatted as: {base_url}/{dataset_id}/{resource}

Examples

let config = ClientConfig::new("https://api.mls.com/odata", "token")
    .with_dataset_id("actris_ref");

pub fn with_timeout(self, timeout: Duration) -> Self

Set custom timeout

Examples

let config = ClientConfig::new("https://api.mls.com/odata", "token")
    .with_timeout(Duration::from_secs(60));

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.