Skip to main content

NoticeBanner

Struct NoticeBanner 

Source
pub struct NoticeBanner {
Show 20 fields pub height: f32, pub logo: Option<LogoSpec>, pub logo_subtitle: String, pub logo_subtitle_color: ColorRgb, pub logo_subtitle_font_size: f32, pub disclaimer: String, pub disclaimer_color: ColorRgb, pub disclaimer_font_size: f32, pub disclaimer_max_lines: u8, pub icon: Option<LogoSpec>, pub label: String, pub label_color: ColorRgb, pub label_font_size: f32, pub note: String, pub note_color: ColorRgb, pub note_font_size: f32, pub rule: bool, pub rule_color: ColorRgb, pub rule_thickness: f32, pub font_families: Vec<String>,
}
Expand description

A masthead drawn at the top of every page: a logo (with an optional subtitle beneath it) on the left, a wrapping disclaimer paragraph below them, an icon on the right whose label is centred beneath it just above an optional note line + full-width rule closing the band.

All text fields are templates ({title} / {date} / {language} / any RenderContext var). Every piece is optional; an empty field is simply skipped. The band reserves height points at the top of the page so body content never collides with it.

Fields§

§height: f32

Reserved vertical space (pt) from the page top.

Left masthead logo.

§logo_subtitle: String

Small line drawn directly under the logo (e.g. a company name).

§logo_subtitle_color: ColorRgb§logo_subtitle_font_size: f32§disclaimer: String

Wrapping disclaimer paragraph, below the logo block.

§disclaimer_color: ColorRgb§disclaimer_font_size: f32§disclaimer_max_lines: u8

Max lines the disclaimer may wrap into (reserves no extra space; the band height governs layout).

§icon: Option<LogoSpec>

Right-side icon (e.g. a warning triangle).

§label: String

Label centred under the icon, just above the closing rule (e.g. "Safety Notice").

§label_color: ColorRgb§label_font_size: f32§note: String

A note line near the band’s bottom (e.g. "Original language: {language}").

§note_color: ColorRgb§note_font_size: f32§rule: bool

Full-width rule closing the band (above the body).

§rule_color: ColorRgb§rule_thickness: f32§font_families: Vec<String>

Font families for this element, in fallback order. Empty means “inherit the document body families” (body_font_families, or the bundled Noto defaults when that is also empty). Names must be families the font collection knows — either system-installed or exposed by a file listed in font_paths.

Note this REPLACES the body list rather than extending it, so a Latin-only face here will lose the multi-script fallbacks. List the scripts you need explicitly if the document is not Latin-only.

Trait Implementations§

Source§

impl Clone for NoticeBanner

Source§

fn clone(&self) -> Self

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 NoticeBanner

Source§

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

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

impl Default for NoticeBanner

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for NoticeBanner

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.