Struct DocConfig 

pub struct DocConfig { /* private fields */ }

Documentation configuration

Implementations

impl DocConfig

pub fn new() -> Self

Create a new documentation configuration

pub fn set_format(&mut self, format: DocFormat)

Set documentation format

pub fn set_theme(&mut self, theme: DocTheme)

Set documentation theme

pub fn set_include_examples(&mut self, include: bool)

Enable/disable examples

pub fn set_include_source_links(&mut self, include: bool)

Enable/disable source links

pub fn set_include_private(&mut self, include: bool)

Enable/disable private member documentation

pub fn set_generate_playground(&mut self, generate: bool)

Enable/disable playground generation

pub fn set_output_directory(&mut self, dir: String)

Set output directory

pub fn set_base_url(&mut self, url: String)

Set base URL

pub fn set_title(&mut self, title: String)

Set documentation title

pub fn set_version(&mut self, version: String)

Set version

Trait Implementations

impl Clone for DocConfig

fn clone(&self) -> DocConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocConfig

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

Formats the value using the given formatter.

impl Default for DocConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<DocConfig> for JsValue

fn from(value: DocConfig) -> Self

Converts to this type from the input type.

impl FromWasmAbi for DocConfig

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for DocConfig

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for DocConfig

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<DocConfig>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for DocConfig

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for DocConfig

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for DocConfig

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<DocConfig>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for DocConfig

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<DocConfig>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for DocConfig

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for DocConfig

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[DocConfig]>

impl VectorIntoWasmAbi for DocConfig

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[DocConfig]>) -> Self::Abi

impl WasmDescribe for DocConfig

fn describe()

impl WasmDescribeVector for DocConfig

fn describe_vector()

impl SupportsConstructor for DocConfig

impl SupportsInstanceProperty for DocConfig

impl SupportsStaticProperty for DocConfig