Struct ObsidianConfig

pub struct ObsidianConfig { /* private fields */ }

Represents the Obsidian configuration, typically loaded from an obsidian.json file.

Implementations

impl ObsidianConfig

pub fn load() -> Result<Self>

Attempts to locate and load the system’s obsidian.json file as an ObsidianConfig.

Returns an Error if the filepath doesn’t exist or JSON parsing failed.

pub fn load_from(config_path: &Path) -> Result<Self>

Attempts to load obsidian.json file as an ObsidianConfig from the given directory Path.

Returns an Error if the filepath doesn’t exist or JSON parsing failed.

Examples

use basalt_core::obsidian::ObsidianConfig;
use std::path::Path;

_ = ObsidianConfig::load_from(Path::new("./dir-with-config-file"));

pub fn vaults(&self) -> Vec<&Vault>

Returns an iterator over the vaults in the configuration.

Examples

use basalt_core::obsidian::{ObsidianConfig, Vault};

let config = ObsidianConfig::from([
    ("Obsidian", Vault::default()),
    ("Work", Vault::default()),
]);

let vaults = config.vaults();

assert_eq!(vaults.len(), 2);
assert_eq!(vaults.get(0), Some(&Vault::default()).as_ref());

pub fn get_vault_by_name(&self, name: &str) -> Option<&Vault>

Finds a vault by name, returning a reference if it exists.

Examples

use basalt_core::obsidian::{ObsidianConfig, Vault};

let config = ObsidianConfig::from([
    ("Obsidian", Vault::default()),
    ("Work", Vault::default()),
]);

_ = config.get_vault_by_name("Obsidian");

pub fn get_open_vault(&self) -> Option<&Vault>

Gets the currently opened vault marked by Obsidian.

Examples

use basalt_core::obsidian::{ObsidianConfig, Vault};

let config = ObsidianConfig::from([
    (
        "Obsidian",
        Vault {
            open: true,
            ..Vault::default()
        },
    ),
    ("Work", Vault::default()),
]);

_ = config.get_open_vault();

Trait Implementations

impl Clone for ObsidianConfig

fn clone(&self) -> ObsidianConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObsidianConfig

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

Formats the value using the given formatter.

impl Default for ObsidianConfig

fn default() -> ObsidianConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObsidianConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> From<[(&str, Vault); N]> for ObsidianConfig

fn from(arr: [(&str, Vault); N]) -> Self

Examples

use basalt_core::obsidian::{ObsidianConfig, Vault};

let config_1 = ObsidianConfig::from([
  ("Obsidian", Vault::default()),
  ("My Vault", Vault::default()),
]);

let config_2: ObsidianConfig = [
  ("Obsidian", Vault::default()),
  ("My Vault", Vault::default()),
].into();

assert_eq!(config_1, config_2);

impl<const N: usize> From<[(String, Vault); N]> for ObsidianConfig

fn from(arr: [(String, Vault); N]) -> Self

Examples

use basalt_core::obsidian::{ObsidianConfig, Vault};

let config_1 = ObsidianConfig::from([
  (String::from("Obsidian"), Vault::default()),
  (String::from("My Vault"), Vault::default()),
]);

let config_2: ObsidianConfig = [
  (String::from("Obsidian"), Vault::default()),
  (String::from("My Vault"), Vault::default()),
].into();

assert_eq!(config_1, config_2);

impl PartialEq for ObsidianConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ObsidianConfig