Enum DocFormat 

pub enum DocFormat {
    HTML,
    Markdown,
    JSON,
    OpenAPI,
    TypeDoc,
}

Documentation output formats

Variants

HTML

HTML documentation with interactive features

Markdown

Markdown documentation

JSON

JSON API documentation

OpenAPI

OpenAPI/Swagger specification

TypeDoc

TypeDoc compatible format

Trait Implementations

impl Clone for DocFormat

fn clone(&self) -> DocFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DocFormat> for JsValue

fn from(value: DocFormat) -> Self

Converts to this type from the input type.

impl FromWasmAbi for DocFormat

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 DocFormat

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 OptionFromWasmAbi for DocFormat

fn is_none(val: &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 DocFormat

fn none() -> Self::Abi

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

impl PartialEq for DocFormat

fn eq(&self, other: &DocFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFromJsValue for DocFormat

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

Performs the conversion.

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

Performs the conversion.

impl VectorFromWasmAbi for DocFormat

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

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

impl VectorIntoWasmAbi for DocFormat

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

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

impl WasmDescribe for DocFormat

fn describe()

impl WasmDescribeVector for DocFormat

fn describe_vector()

impl Copy for DocFormat

impl Eq for DocFormat

impl StructuralPartialEq for DocFormat