Struct deadwiki::db::DB

pub struct DB { /* fields omitted */ }

Implementations

impl DB

pub fn new<S: AsRef<str>>(root: S) -> DB

Create a new DB object. Should only have one per run.

pub fn is_empty(&self) -> bool

Is this DB empty?

pub fn len(&self) -> usize

How many wiki pages have been created?

pub fn find(&self, name: &str) -> Option<Page>

Find a single wiki page by name.

pub fn exists(&self, name: &str) -> bool

Check if a wiki page exists by name.

pub fn pages(&self) -> Result<Vec<Page>>

All the wiki pages, in alphabetical order.

pub fn names(&self) -> Result<Vec<String>>

All the wiki page names, in alphabetical order.

pub fn titles(&self) -> Result<Vec<String>>

All the wiki page titles, in alphabetical order.

pub fn recent(&self) -> Result<Vec<Page>>

Recently modified wiki pages.

pub fn tags(&self) -> Result<Vec<String>>

All the tags used, in alphabetical order.

pub fn find_pages_with_tag(&self, tag: &str) -> Result<Vec<Page>>

pub fn create(&self, name: &str, body: &str) -> Result<Page>

Create a new wiki page on disk. Name should be the title, such as "Linux Laptops" - it'll get converted to linux_laptops.md.

pub fn update(&self, name: &str, body: &str) -> Result<Page>

Save a page to disk. Doesn't track renames, just content changes for now.

pub fn absolute_path(&self, path: &str) -> String

Get an FS path to a file, without changing case or characters.

pub fn is_git(&self) -> bool

Is this DB tracked with git?

pub fn title_to_name(title: &str) -> String

"Keyboard Shortcut" -> "Keyboard_Shortcut"

Trait Implementations

impl Send for DB

impl Sync for DB