Skip to main content

CalloutKind

Enum CalloutKind 

Source
pub enum CalloutKind {
Show 16 variants Note, Abstract, Info, Todo, Tip, Success, Question, Warning, Failure, Danger, Bug, Example, Quote, Important, Summary, Help,
}
Expand description

Canonical callout kind. Obsidian-dialect aliases canonicalize via CalloutKind::from_raw (e.g. tldr/summaryCalloutKind::Abstract). Unknown kinds fall back to CalloutKind::Note; the parser logs at trace level (Diagnostic threading is a Phase 4 followup — see validation::Diagnostic, today scoped to frontmatter validation).

Variants§

§

Note

§

Abstract

§

Info

§

Todo

§

Tip

§

Success

§

Question

§

Warning

§

Failure

§

Danger

§

Bug

§

Example

§

Quote

§

Important

§

Summary

§

Help

Implementations§

Source§

impl CalloutKind

Source

pub fn from_raw(raw: &str) -> Option<Self>

Canonicalize a raw callout name (case-insensitive) to a CalloutKind. Returns None if the name is not a recognized canonical kind or alias.

Alias table (Obsidian-dialect, per shape-spec § 1):

  • tldr / summaryAbstract
  • hint / importantTip
  • check / doneSuccess
  • help / faqQuestion
  • caution / attentionWarning
  • fail / missingFailure
  • errorDanger
  • citeQuote

pending is also accepted as an alias for Todo (used by SoCiviC Theatre voices.md; carried over from pre-Phase-4 Stage 1 support in crates/moss-core/src/resolve/callouts.rs).

Note: the CalloutKind enum reserves Important, Summary, and Help as canonical variants for future Stage 2 use (e.g. editor-emitted callouts that should not name-clash with the Obsidian aliases above). Author markdown can’t currently produce these three through from_raw; they’re reachable only via programmatic construction.

Source

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

Slug form used in the rendered data-type attribute.

Source

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

Default display title (capitalized canonical kind) used when the author wrote > [!type] with no inline title text.

Trait Implementations§

Source§

impl Clone for CalloutKind

Source§

fn clone(&self) -> CalloutKind

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 CalloutKind

Source§

impl Debug for CalloutKind

Source§

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

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

impl<'de> Deserialize<'de> for CalloutKind

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CalloutKind

Source§

impl Hash for CalloutKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CalloutKind

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for CalloutKind

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CalloutKind

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.