Struct rocket_okapi::rapidoc::UiConfig

source · [−]

pub struct UiConfig {
    pub theme: Theme,
    pub bg_color: String,
    pub text_color: String,
    pub header_color: String,
    pub primary_color: String,
    pub load_fonts: bool,
    pub regular_font: String,
    pub mono_font: String,
    pub font_size: FontSize,
}

Expand description

A struct containing information about where and how the openapi.json files are served.

Fields

theme: Theme

Is the base theme, which is used for calculating colors for various UI components. ‘theme’, ‘bg-color’ and ‘text-color’ are the base attributes for generating a custom theme.

The default is Theme::Light.

bg_color: String

Hex color code for main background.

text_color: String

Hex color code for text.

header_color: String

Hex color code for the header’s background.

primary_color: String

Hex color code on various controls such as buttons, tabs.

load_fonts: bool

RapiDoc will attempt to load fonts from CDN, if this is not intended, then set this to false.

The default is true.

regular_font: String

Font Name(s) to be used for regular text.

mono_font: String

Font Name(s) to be used for mono-spaced text.

font_size: FontSize

Sets the relative font sizes for the entire document.

The default is FontSize::Default.

Trait Implementations

impl Clone for UiConfig

fn clone(&self) -> UiConfig

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for UiConfig

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

Formats the value using the given formatter. Read more

impl Default for UiConfig

fn default() -> Self

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

Auto Trait Implementations

impl RefUnwindSafe for UiConfig

impl Send for UiConfig

impl Sync for UiConfig

impl Unpin for UiConfig

impl UnwindSafe for UiConfig

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> IntoCollection<T> for T

fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,

Converts self into a collection.

fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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