Skip to main content

DocType

surf_parse::types

Enum DocType

pub enum DocType {
Show 18 variants    Doc,
    Guide,
    Conversation,
    Plan,
    Agent,
    Preference,
    Report,
    Proposal,
    Incident,
    Review,
    App,
    Manifest,
    Website,
    Web,
    Deck,
    Slides,
    Presentation,
    Paper,
}

Expand description

SurfDoc document types (front matter type field).

Variants§

Doc

Guide

Conversation

Plan

Agent

Preference

Report

Proposal

Incident

Review

App

Manifest

Website

Multi-page website (rendered via the ::site/::page block family).

Web

Multi-page web document. Synonym of DocType::Website: drives the exact same ::site/::page multipage render path (rendering keys off the blocks, not the type), so type: web and type: website produce identical output for the same body.

Deck

Presentation deck (rendered via the ::deck/::slide block family).

Slides

Alias for DocType::Deck — type: slides in front matter.

Presentation

Presentation. Resolves to the same render profile as DocType::Deck/DocType::Slides (the slides path).

Paper

Scientific/academic paper. Pairs with a Format (ieee/acm/ article) to select a paper template at render time.

Trait Implementations§

impl Clone for DocType

fn clone(&self) -> DocType

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for DocType

impl Debug for DocType

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for DocType

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

Deserialize this value from the given Serde deserializer. Read more

impl Eq for DocType

impl PartialEq for DocType

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for DocType

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for DocType

Auto Trait Implementations§

impl Freeze for DocType

impl RefUnwindSafe for DocType

impl Send for DocType

impl Sync for DocType

impl Unpin for DocType

impl UnsafeUnpin for DocType

impl UnwindSafe for DocType

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.