Enum rocket_okapi::rapidoc::RenderStyle

source · [−]

#[non_exhaustive]
pub enum RenderStyle {
    View,
    Read,
    Focused,
}

Expand description

Determines display of api-docs. Currently there are two modes supported. ‘read’ - more suitable for reading and ‘view’ more friendly for quick exploring

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

`View`

Friendly for quick exploring (expand/collapse the section of your interest).

`Read`

Suitable for reading (like a continuous web-page).

`Focused`

Similar to read but focuses on a single endpoint at a time (good for large specs).

Enum rocket_okapi::rapidoc::RenderStyle

Variants (Non-exhaustive)

View

Read

Focused

Trait Implementations

impl Clone for RenderStyle

fn clone(&self) -> RenderStyle

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

impl Debug for RenderStyle

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

impl Display for RenderStyle

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

Auto Trait Implementations

impl RefUnwindSafe for RenderStyle

impl Send for RenderStyle

impl Sync for RenderStyle

impl Unpin for RenderStyle

impl UnwindSafe for RenderStyle

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoCollection<T> for T

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

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

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

type Owned = T

fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

`View`

`Read`

`Focused`

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

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

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

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

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

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

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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

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

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

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