Enum ArchiveIndex

pub enum ArchiveIndex {
    Library {
        archive: ArchiveId,
        title: Box<str>,
        teaser: Option<Box<str>>,
        thumbnail: Option<Box<str>>,
    },
    Book {
        title: Box<str>,
        authors: Box<[Box<str>]>,
        file: DocumentURI,
        teaser: Option<Box<str>>,
        thumbnail: Option<Box<str>>,
    },
    Paper {
        title: Box<str>,
        authors: Box<[Box<str>]>,
        file: DocumentURI,
        thumbnail: Option<Box<str>>,
        teaser: Option<Box<str>>,
        venue: Option<Box<str>>,
        venue_url: Option<Box<str>>,
    },
    Course {
        title: Box<str>,
        landing: DocumentURI,
        acronym: Option<Box<str>>,
        instructors: Box<[Box<str>]>,
        institution: Box<str>,
        instances: Box<[Instance]>,
        notes: DocumentURI,
        slides: Option<DocumentURI>,
        thumbnail: Option<Box<str>>,
        quizzes: bool,
        homeworks: bool,
        teaser: Option<Box<str>>,
    },
    SelfStudy {
        title: Box<str>,
        landing: DocumentURI,
        notes: DocumentURI,
        acronym: Option<Box<str>>,
        slides: Option<DocumentURI>,
        thumbnail: Option<Box<str>>,
        teaser: Option<Box<str>>,
    },
}

Available on crate feature serde only.

Variants

Library

Fields

archive: ArchiveId

title: Box<str>

teaser: Option<Box<str>>

thumbnail: Option<Box<str>>

Book

Fields

title: Box<str>

authors: Box<[Box<str>]>

file: DocumentURI

teaser: Option<Box<str>>

thumbnail: Option<Box<str>>

Paper

Fields

title: Box<str>

authors: Box<[Box<str>]>

file: DocumentURI

thumbnail: Option<Box<str>>

teaser: Option<Box<str>>

venue: Option<Box<str>>

venue_url: Option<Box<str>>

Course

Fields

title: Box<str>

landing: DocumentURI

acronym: Option<Box<str>>

instructors: Box<[Box<str>]>

institution: Box<str>

instances: Box<[Instance]>

notes: DocumentURI

slides: Option<DocumentURI>

thumbnail: Option<Box<str>>

quizzes: bool

homeworks: bool

teaser: Option<Box<str>>

SelfStudy

Fields

title: Box<str>

landing: DocumentURI

notes: DocumentURI

acronym: Option<Box<str>>

slides: Option<DocumentURI>

thumbnail: Option<Box<str>>

teaser: Option<Box<str>>

Implementations

impl ArchiveIndex

pub fn teaser(&self) -> Option<&str>

pub fn set_teaser(&mut self, new_teaser: Box<str>)

impl ArchiveIndex

pub fn from_kind( d: DocumentKind, a: &ArchiveURI, images: impl FnMut(Box<str>) -> Box<str>, ) -> Result<Self>

Trait Implementations

impl Clone for ArchiveIndex

fn clone(&self) -> ArchiveIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArchiveIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ArchiveIndex> for JsValue

where ArchiveIndex: Serialize,

fn from(value: ArchiveIndex) -> Self

Converts to this type from the input type.

impl FromWasmAbi for ArchiveIndex

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 ArchiveIndex

where ArchiveIndex: 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 ArchiveIndex

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 ArchiveIndex

where ArchiveIndex: Serialize,

fn none() -> Self::Abi

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

impl PartialEq for ArchiveIndex

fn eq(&self, other: &Self) -> 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 RefFromWasmAbi for ArchiveIndex

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<ArchiveIndex>

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 ArchiveIndex

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 ArchiveIndex

const DECL: &'static str = "export type ArchiveIndex = { type: \"library\"; archive: ArchiveId; title: string; teaser?: string | undefined; thumbnail?: string | undefined } | { type: \"book\"; title: string; authors: string[]; file: DocumentURI; teaser?: string | undefined; thumbnail?: string | undefined } | { type: \"paper\"; title: string; authors: string[]; file: DocumentURI; thumbnail?: string | undefined; teaser?: string | undefined; venue?: string | undefined; venue_url?: string | undefined } | { type: \"course\"; title: string; landing: DocumentURI; acronym: string | undefined; instructors: string[]; institution: string; instances: Instance[]; notes: DocumentURI; slides?: DocumentURI | undefined; thumbnail?: string | undefined; quizzes?: boolean; homeworks?: boolean; teaser?: string | undefined } | { type: \"self-study\"; title: string; landing: DocumentURI; notes: DocumentURI; acronym?: string | undefined; slides?: DocumentURI | undefined; thumbnail?: string | undefined; teaser?: string | 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 ArchiveIndex

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

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

impl VectorIntoWasmAbi for ArchiveIndex

where ArchiveIndex: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

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

impl WasmDescribe for ArchiveIndex

fn describe()

impl WasmDescribeVector for ArchiveIndex

fn describe_vector()

impl Eq for ArchiveIndex