Skip to main content

BaseFile

Struct BaseFile 

Source
pub struct BaseFile {
    pub title: Option<String>,
    pub filters: Option<Filter>,
    pub formulas: BTreeMap<String, String>,
    pub properties: BTreeMap<String, PropertyConfig>,
    pub summaries: BTreeMap<String, String>,
    pub views: Vec<View>,
    pub docgen_interactive: Option<InteractiveToggle>,
}
Expand description

A parsed .base file.

Fields§

§title: Option<String>

docgen-specific (Obsidian-ignored): the page title for a standalone .base file. None falls back to the file’s name. Lets a base whose file name is a slug (e.g. releases.base) present a proper title (“Releases”).

§filters: Option<Filter>

Global filter tree applied to every view.

§formulas: BTreeMap<String, String>

Named formulas: name → expression string.

§properties: BTreeMap<String, PropertyConfig>

Per-property display configuration.

§summaries: BTreeMap<String, String>

Named custom summary expressions.

§views: Vec<View>

The views to render, in order.

§docgen_interactive: Option<InteractiveToggle>

docgen-specific (Obsidian-ignored): a bare bool that enables/disables the interactive island for the whole base. false = force pure static.

Trait Implementations§

Source§

impl Clone for BaseFile

Source§

fn clone(&self) -> BaseFile

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 Debug for BaseFile

Source§

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

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

impl Default for BaseFile

Source§

fn default() -> BaseFile

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BaseFile

Source§

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

Deserialize this value from the given Serde deserializer. Read more

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<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.