Skip to main content

EmbedStyle

Enum EmbedStyle 

Source
pub enum EmbedStyle {
    Delimited,
    CodeBlock,
    HtmlScript,
    HtmlCode,
    Separate,
}
Expand description

The archetype family a workspace authors embedded metadata in — the “embed type” the CLI’s init prompts for, one level above the concrete EmbedType. A family plus a metadata fig::Format resolves to a carrier through embed_carrier: e.g. (CodeBlock, YAML) is a ```yaml block, (Delimited, TOML) is a +++ block, and (Separate, JSON) is a whole-file .json sidecar. It is what the config document records (via prov’s WorkspaceConfig) so a workspace stays self-describing about how its metadata is embedded, not just which format it is written in.

Variants§

§

Delimited

Character-delimited frontmatter: --- YAML, +++ TOML, ;;; JSON. A Markdown convention; the fig dialect has no delimiter form.

§

CodeBlock

A typed fenced code block — ```yaml, ```toml, ```json, ```fig — that renders as a visible block in Markdown or Djot.

§

HtmlScript

An HTML <script type="application/…"> data island (not rendered).

§

HtmlCode

An HTML <pre><code class="language-…"> visible code block.

§

Separate

Metadata kept in a sibling whole-file document, joined to a plain body file by a content attribute — neither file carries fences.

Implementations§

Source§

impl EmbedStyle

Source

pub fn as_config_str(self) -> &'static str

The embed_type config-document spelling for this style.

Source

pub fn from_config_str(value: &str) -> Option<Self>

Parse an embed_type config value. Unknown → None (keep the default).

Trait Implementations§

Source§

impl Clone for EmbedStyle

Source§

fn clone(&self) -> EmbedStyle

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 EmbedStyle

Source§

impl Debug for EmbedStyle

Source§

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

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

impl Eq for EmbedStyle

Source§

impl PartialEq for EmbedStyle

Source§

fn eq(&self, other: &EmbedStyle) -> 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 EmbedStyle

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.