Struct InteractiveDocumentation

Source

pub struct InteractiveDocumentation {
    pub api_reference: ApiReference,
    pub live_examples: Vec<LiveCodeExample>,
    pub searchable_index: SearchIndex,
    pub interactive_tutorials: Vec<InteractiveTutorial>,
    pub visualizations: Vec<ApiVisualization>,
    pub playground_config: PlaygroundConfig,
}

Expand description

Interactive documentation with live examples and features

Fields§

§api_reference: ApiReference

Base API reference

§live_examples: Vec<LiveCodeExample>

Live executable examples

§searchable_index: SearchIndex

Searchable index

§interactive_tutorials: Vec<InteractiveTutorial>

Interactive tutorials

§visualizations: Vec<ApiVisualization>

Visualizations

§playground_config: PlaygroundConfig

Playground configuration

Trait Implementations§

Source §

impl Clone for InteractiveDocumentation

Source §

fn clone(&self) -> InteractiveDocumentation

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for InteractiveDocumentation

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for InteractiveDocumentation

Source §

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

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for InteractiveDocumentation

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for InteractiveDocumentation

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, U> Into 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 §