Enum DocumentOptions

pub enum DocumentOptions {
    FromBackend {
        uri: DocumentURI,
        gottos: Option<Vec<Gotto>>,
        toc: Option<TOCOptions>,
    },
    HtmlString {
        html: String,
        gottos: Option<Vec<Gotto>>,
        toc: Option<Vec<TOCElem>>,
    },
}

Available on crate feature ts only.

Options for rendering an FTML document

• FromBackend: calls the backend for the document uri: the URI of the document (as string) toc: if defined, will render a table of contents for the document
• HtmlString: render the provided HTML String html: the HTML String toc: if defined, will render a table of contents for the document

Variants

FromBackend

Fields

uri: DocumentURI

gottos: Option<Vec<Gotto>>

toc: Option<TOCOptions>

HtmlString

Fields

html: String

gottos: Option<Vec<Gotto>>

toc: Option<Vec<TOCElem>>

Trait Implementations

impl Clone for DocumentOptions

fn clone(&self) -> DocumentOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DocumentOptions> for JsValue

where DocumentOptions: Serialize,

fn from(value: DocumentOptions) -> Self

Converts to this type from the input type.

impl FromWasmAbi for DocumentOptions

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

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

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for DocumentOptions

where DocumentOptions: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl OptionFromWasmAbi for DocumentOptions

where Self: DeserializeOwned,

fn is_none(js: &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 DocumentOptions

where DocumentOptions: Serialize,

fn none() -> Self::Abi

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

impl RefFromWasmAbi for DocumentOptions

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<DocumentOptions>

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 Serialize for DocumentOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for DocumentOptions

const DECL: &'static str = "/**\n * Options for rendering an FTML document\n * - `FromBackend`: calls the backend for the document\n * uri: the URI of the document (as string)\n * toc: if defined, will render a table of contents for the document\n * - `HtmlString`: render the provided HTML String\n * html: the HTML String\n * toc: if defined, will render a table of contents for the document\n */\nexport type DocumentOptions = { type: \"FromBackend\"; uri: DocumentURI; gottos?: Gotto[] | undefined; toc: TOCOptions | undefined } | { type: \"HtmlString\"; html: string; gottos?: Gotto[] | undefined; toc: TOCElem[] | undefined };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl VectorFromWasmAbi for DocumentOptions

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

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

impl VectorIntoWasmAbi for DocumentOptions

where DocumentOptions: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

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

impl WasmDescribe for DocumentOptions

fn describe()

impl WasmDescribeVector for DocumentOptions

fn describe_vector()