Struct ShieldClientOptions 

pub struct ShieldClientOptions { /* private fields */ }

Configuration for ShieldClient.

use highflame_shield::ShieldClientOptions;
use std::time::Duration;

let opts = ShieldClientOptions::new("hf_sk_my_key")
    .base_url("https://shield.self-hosted.example.com")
    .timeout(Duration::from_secs(10))
    .max_retries(1);

Implementations

impl ShieldClientOptions

pub fn new(api_key: impl Into<String>) -> Self

Create options from just an API key; all other fields take defaults.

pub fn base_url(self, url: impl Into<String>) -> Self

Override the guard service base URL (default: Highflame SaaS endpoint).

pub fn token_url(self, url: impl Into<String>) -> Self

Override the token exchange URL (default: Highflame SaaS endpoint). Only used when api_key starts with hf_sk.

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

Request timeout (default: 30 s).

pub fn max_retries(self, n: u32) -> Self

Number of retries on 429 / 5xx (default: 2).

pub fn account_id(self, id: impl Into<String>) -> Self

Override X-Account-ID header; takes precedence over the token exchange value.

pub fn project_id(self, id: impl Into<String>) -> Self

Override X-Project-ID header; takes precedence over the token exchange value.

Trait Implementations

impl Clone for ShieldClientOptions

fn clone(&self) -> ShieldClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShieldClientOptions

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

Formats the value using the given formatter.