Skip to main content

EmbedType

Enum EmbedType 

Source
#[non_exhaustive]
pub enum EmbedType {
Show 19 variants FrontmatterYaml, FrontmatterJson, EndmatterYaml, FrontmatterFig, PlusToml, FencedYaml, FencedJson, FencedToml, MdFrontmatterJson, MdFrontmatterToml, MdFrontmatterFig, HtmlScriptFig, HtmlScriptYaml, HtmlScriptJson, HtmlScriptToml, HtmlCodeFig, HtmlCodeYaml, HtmlCodeJson, HtmlCodeToml,
}
Expand description

The embed archetype a fenced metadata block was found in. Re-exported from fig, which owns both detection (fig::detect) and the fence/format coupling (EmbedType::inner_format). Which embedded config to open — the flat mirror of fig’s parametric Embed.Type. The three parametric families (markdown ---<lang> frontmatter, ```<lang> fenced blocks, <script type> HTML data islands) are enumerated once per format. The first four names are historical (FrontmatterJson is the ;;; block, FrontmatterFig is the ```fig fenced block); the rest are grouped by container.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

FrontmatterYaml

------/... bare YAML frontmatter.

§

FrontmatterJson

;;;;;; JSON frontmatter.

§

EndmatterYaml

YAML in a trailing ```endmatter code block.

§

FrontmatterFig

```fig``` fenced block (the fig authoring dialect).

§

PlusToml

++++++ TOML frontmatter — the Hugo/Zola convention.

§

FencedYaml

```yaml fenced block.

§

FencedJson

```json fenced block.

§

FencedToml

```toml fenced block.

§

MdFrontmatterJson

---json--- markdown frontmatter.

§

MdFrontmatterToml

---toml--- markdown frontmatter.

§

MdFrontmatterFig

---fig--- markdown frontmatter.

§

HtmlScriptFig

<script type="application/figl"></script> HTML data island.

§

HtmlScriptYaml

<script type="application/yaml"></script> HTML data island.

§

HtmlScriptJson

<script type="application/json"></script> HTML data island.

§

HtmlScriptToml

<script type="application/toml"></script> HTML data island.

§

HtmlCodeFig

<pre><code class="language-figl"></code></pre> visible code block. Content is entity-encoded; editing decodes on open and re-encodes span-aware on render, so an edit preserves every untouched byte’s original encoding while canonically encoding only what changed.

§

HtmlCodeYaml

<pre><code class="language-yaml"> visible code block.

§

HtmlCodeJson

<pre><code class="language-json"> visible code block.

§

HtmlCodeToml

<pre><code class="language-toml"> visible code block.

Implementations§

Source§

impl EmbedType

Source

pub fn inner_format(self) -> Format

The inner format this archetype’s content is written in (and serialized to when spliced in). Lets a caller resolve the parser to use for a detected embed’s content instead of duplicating the archetype→format mapping.

Trait Implementations§

Source§

impl Clone for EmbedType

Source§

fn clone(&self) -> EmbedType

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
Source§

impl Copy for EmbedType

Source§

impl Debug for EmbedType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EmbedType

Source§

impl PartialEq for EmbedType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EmbedType

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

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

Source§

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

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

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.