Struct WhitelabelConfig 

pub struct WhitelabelConfig {
    pub name: String,
    pub mark: String,
    pub subtitle: String,
    pub logo_url: Option<String>,
    pub page_title: String,
    pub parent_url: Option<String>,
    pub parent_name: String,
    pub api_docs_url: Option<String>,
    pub css_url: Option<String>,
    pub favicon_url: Option<String>,
    pub default_namespace: String,
}

Operator-configurable dashboard identity. Construct via WhitelabelConfig::from_env in production; tests can build instances directly.

Fields

name: String

mark: String

Single-letter (or short) glyph rendered inside the always-visible badge square at the top of the sidebar. Derived from the first character of name unless ASSAY_WHITELABEL_MARK overrides.

subtitle: String

Muted subtitle rendered beneath the brand name (empty → no subtitle line). Gives operators the canonical two-line brand block without needing a custom logo SVG.

logo_url: Option<String>

page_title: String

parent_url: Option<String>

parent_name: String

api_docs_url: Option<String>

Some(url) → render the link pointing at url. None → hide the link entirely.

css_url: Option<String>

Optional stylesheet URL loaded after assay’s own CSS. Operators use this to re-skin the dashboard by overriding CSS custom properties or specific selectors without touching the source.

favicon_url: Option<String>

Optional favicon URL. When None the built-in SVG A-mark is served at /workflow/favicon.svg; when Some(url) the template points <link rel="icon"> at the operator’s URL instead.

default_namespace: String

Namespace the dashboard opens on by default. Operators running assay single-tenant (all workflows in one non-main namespace) shouldn’t force every user to change the dropdown on first load.

Implementations

impl WhitelabelConfig

pub fn is_customised(&self) -> bool

true when any operator-facing identity field has been overridden from the default. Drives the “Powered by …” prefix in the footer version line — attribution without burying the engine on the standalone dashboard.

impl WhitelabelConfig

pub fn from_env() -> Self

Read every knob from env, applying defaults and the “set-to-empty means hide” convention for api_docs_url.

Trait Implementations

impl Clone for WhitelabelConfig

fn clone(&self) -> WhitelabelConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WhitelabelConfig

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

Formats the value using the given formatter.