Skip to main content

Value

Enum Value 

Source
pub enum Value {
    Null,
    Bool(bool),
    Number(f64),
    Str(String),
    Date(BaseDate),
    Duration(i64),
    List(Vec<Value>),
    Object(BTreeMap<String, Value>),
    Link(BaseLink),
}
Expand description

A runtime value in the Bases expression language.

Variants§

§

Null

§

Bool(bool)

§

Number(f64)

§

Str(String)

§

Date(BaseDate)

§

Duration(i64)

A duration in milliseconds (from duration(...) or a date subtraction).

§

List(Vec<Value>)

§

Object(BTreeMap<String, Value>)

Implementations§

Source§

impl Value

Source

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

A short type name, for isType(...) and diagnostics.

Source

pub fn is_truthy(&self) -> bool

Obsidian truthiness: null / false / 0 / empty string / empty list / empty object are falsey; everything else is truthy. Drives filters and if(...).

Source

pub fn is_empty(&self) -> bool

Whether the value is “empty” for isEmpty() / the Filled/Empty summaries: null, empty string, empty list, or empty object.

Source

pub fn as_number(&self) -> Option<f64>

Best-effort numeric coercion (for arithmetic and number(...)). Booleans → 0/1, numeric strings parse, durations → their millisecond count; otherwise None.

Source

pub fn as_str_coerced(&self) -> String

Coerce to a string the way an expression’s + with a string operand would.

Source

pub fn display(&self) -> String

The human-facing rendering used for table cells and string coercion. Numbers drop a trailing .0; lists join with , ; links show their display or basename; dates use their default format.

Source§

impl Value

Source

pub fn loose_eq(&self, other: &Value) -> bool

Structural equality used by ==/!= and .contains(...). Numbers compare numerically (incl. across numeric strings), links compare by target, dates by instant; mismatched types are unequal (except numeric coercion).

Source

pub fn loose_cmp(&self, other: &Value) -> Ordering

Ordering for </>/sorting. Numbers and dates order naturally; strings lexicographically (case-insensitive, like Obsidian’s column sort); other combinations fall back to a stable type-name ordering so a sort never panics on mixed columns. Null sorts last.

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

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 Value

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnsafeUnpin for Value

§

impl UnwindSafe for Value

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