Skip to main content

SiteBranding

Struct SiteBranding 

Source
pub struct SiteBranding {
    pub app_name: String,
    pub app_tagline: Option<String>,
    pub support_email: Option<String>,
    pub public_url: Option<String>,
    pub show_powered_by: bool,
    pub site_title: String,
    pub site_header: String,
    pub index_title: String,
    pub footer_copyright: String,
    pub domain: String,
}
Expand description

Per-project admin branding — the user-facing identity layer.

Production deployments MUST set SiteBranding::app_name (or use the Admin::app_name builder) — the framework name RustIO should never appear as the visible product identity for end users. RustIO is the vendor; the deployed application is what users see in their inbox, on the login page, and in the password-reset flow.

Field roles:

  • app_name — primary user-facing product identity. Used by every framework-emitted surface that reaches end users: email subjects + headers, recovery pages, admin chrome footer, audit summaries.
  • app_tagline — optional secondary line. Renders as the descriptor under the brand wordmark in recovery emails. None falls back to the framework’s generic “Account security notification” caption.
  • support_email — optional contact surfaced in the recovery email footer (“If you didn’t request this, contact <support@…>”). None omits the line.
  • public_url — canonical public URL used when composing reset links if the request’s Host / X-Forwarded-Host derivation is unreliable. None falls back to header-derived URLs.
  • show_powered_by — opt-in “Powered by RustIO” credit in the chrome footer + email footer. Defaults to false; the framework name stays invisible to end users unless the project explicitly enables this.

Legacy fields (site_title / site_header / etc.) predate this architecture and are still honoured for backwards compatibility, but their defaults were renamed away from “RustIO administration” so a zero-config build no longer leaks the framework name. New code should use the app_* fields exclusively.

Fields§

§app_name: String

Primary user-facing product identity. Visible in: page chrome (topbar, footer), email subjects + headers, audit summaries, recovery pages, login screen.

§app_tagline: Option<String>

Optional secondary line for use under the brand wordmark in emails / auth surfaces. Examples: “Operational library management”, “Health-system administration”. None falls back to “Account security notification” in recovery emails.

§support_email: Option<String>

Optional support contact surfaced in recovery email footer.

§public_url: Option<String>

Optional canonical public URL — e.g. https://library.example.com. Used as the reset-link base when Host header isn’t trustworthy.

§show_powered_by: bool

true → renders a small, low-contrast “Powered by RustIO” line in the admin chrome footer and at the very bottom of framework emails. Default: false (framework name invisible).

§site_title: String§site_header: String§index_title: String§footer_copyright: String§domain: String

DNS-shape string available to project handlers; not surfaced in any framework template.

Trait Implementations§

Source§

impl Clone for SiteBranding

Source§

fn clone(&self) -> SiteBranding

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SiteBranding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SiteBranding

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more