Struct Context

pub struct Context<S: ContextState + ?Sized> { /* private fields */ }

Tiny wrapper around “Tera context” with some additional information.

Implementations

impl<S: ContextState> Context<S>

The methods below are available in all ContentState states.

pub fn get_path(&self) -> &Path

Getter for self.path. See from() method for details.

pub fn get_dir_path(&self) -> &Path

Getter for self.dir_path. See from() method for details.

pub fn get_root_path(&self) -> &Path

Getter for self.root_path. See from() method for details.

pub fn get_doc_file_date(&self) -> Option<SystemTime>

Getter for self.doc_file_date. See from() method for details.

pub fn from_context_path(context: &Context<S>) -> Context<HasSettings>

Constructor. Unlike from() this constructor does not access the file system in order to detect dir_path, root_path and doc_file_date. It copies these values from the passed context. Use this constructor when you are sure that the above date has not changed since you instantiated context. In this case you can avoid repeated file access.

impl Context<Invalid>

The start state of all Context objects.

pub fn from(path: &Path) -> Result<Context<HasSettings>, FileError>

Constructor: path is Tp-Notes first positional command line parameter <path> (see man page). path must point to a directory or a file.

A copy of path is stored in self.ct as key TMPL_VAR_PATH. It directory path as key TMPL_VAR_DIR_PATH. The root directory, where the marker file tpnote.toml was found, is stored with the key TMPL_VAR_ROOT_PATH. If path points to a file, its file creation date is stored with the key TMPL_VAR_DOC_FILE_DATE.

use std::path::Path;
use tpnote_lib::settings::set_test_default_settings;
use tpnote_lib::config::TMPL_VAR_DIR_PATH;
use tpnote_lib::config::TMPL_VAR_PATH;
use tpnote_lib::context::Context;
set_test_default_settings().unwrap();

let mut context = Context::from(&Path::new("/path/to/mynote.md")).unwrap();

assert_eq!(context.get_path(), Path::new("/path/to/mynote.md"));
assert_eq!(context.get_dir_path(), Path::new("/path/to/"));
assert_eq!(&context.get(TMPL_VAR_PATH).unwrap().to_string(),
            r#""/path/to/mynote.md""#);
assert_eq!(&context.get(TMPL_VAR_DIR_PATH).unwrap().to_string(),
            r#""/path/to""#);

Methods from Deref<Target = Context>

pub fn get(&self, index: &str) -> Option<&Value>

Returns the value at a given key index.

pub fn contains_key(&self, index: &str) -> bool

Checks if a value exists at a specific index.

Trait Implementations

impl<S: Clone + ContextState + ?Sized> Clone for Context<S>

fn clone(&self) -> Context<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + ContextState + ?Sized> Debug for Context<S>

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

Formats the value using the given formatter.

impl<S: ContextState> Deref for Context<S>

Auto dereferences for convenient access to tera::Context.

type Target = Context

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: PartialEq + ContextState + ?Sized> PartialEq for Context<S>

fn eq(&self, other: &Context<S>) -> 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<S: ContextState + ?Sized> StructuralPartialEq for Context<S>