Struct TenantConfig 

#[non_exhaustive]
pub struct TenantConfig {
    pub strategy: TenantStrategy,
    pub header_name: String,
    pub parameter_name: String,
    pub domain_fallback: Option<String>,
}

Configuration settings for multitenancy extraction.

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.

strategy: TenantStrategy

The extraction strategy to be used.

header_name: String

The name of the custom HTTP header (used only with TenantStrategy::Header).

parameter_name: String

The name of the query parameter (used only with TenantStrategy::Parameter).

domain_fallback: Option<String>

Fallback tenant ID to use when subdomain/header resolution fails or is absent.

Implementations

impl TenantConfig

pub fn new(strategy: TenantStrategy) -> Self

Creates a new TenantConfig with default values:

• Header Name: X-Tenant-ID
• Parameter Name: tenant_id
• Domain Fallback: None

pub fn with_header_name<S: Into<String>>(self, name: S) -> Self

Set a custom HTTP header name to extract the tenant ID from.

pub fn with_parameter_name<S: Into<String>>(self, name: S) -> Self

Set a custom Query Parameter name to extract the tenant ID from.

pub fn with_domain_fallback<S: Into<String>>(self, fallback: S) -> Self

Set a fallback tenant ID when domain extraction fails in Subdomain strategy.

Trait Implementations

impl Clone for TenantConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TenantConfig

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

Formats the value using the given formatter.