Crate tpnote_lib

The tpnote-lib library is designed to embed Tp-Note’s core function in common text editors and text editor plugins. It is dealing with templates and input files and is also part of the command line application Tp-Note. This library also provides a default configuration in the static variable LIB_CFG that can be customized at runtime. The defaults for the variables grouped in LIB_CFG, are defined as constants in the module config (see Rustdoc).

tpnote-lib offers a high-level API and a low-level API. The high-level API, c.f. module workflow abstracts most implementation details. Roughly speaking, the input path correspond to Tp-Note’s first positional command line parameter and the output path is the same that is printed to stdout after usage. The heart of the low-level API is the module note. Everything else is designed around. In note you will find some Rustdoc tests illustrating the usage of this API. Most other modules are not called directly and might change to private in the future. The consumer of the low-level API in the module note is the high-level API in the module workflow.

The main consumer of tpnote-lib’s high-level API is the module workflow in tp-note crate. In addition to the above-mentioned Rustdoc tests, the source code of tp-note::workflow and tpnote_lib::workflow showcases the usage of the high-level API and of the low-level API the best.

Modules

config

Set configuration defaults, reads and writes Tp-Note’s configuration file and exposes the configuration as static variable behind a mutex. This makes it possible to modify all configuration defaults (and templates) at runtime.

content

Self referencing data structures to store the note’s content as a raw string.

context

Extends the built-in Tera filters.

error

Custom error types.

filename

Helper functions that deal with filenames.

filter

Extends the built-in Tera filters.

front_matter

Creates a memory representation of the note’s YAML header. In this documentation, the terms “YAML header”, ”header” and ”front matter“ are used as synonyms for the note’s meta data block at the beginning of the text file. Technically this is a wrapper around a tera::Map.

note

Tp-Note’s low level API, creating a memory representation of a
note file by inserting Tp-Note’s environment data in some templates. If the note exists on disk already, the memory representation is established be reading the note file and parsing its front matter. NB: The high level API is in the module tpnote_lib::workflow.

template

Abstractions for content templates and filename templates.

workflow

Tp-Note’s high level API. The low level API is documented in the module tpnote_lib::note.

Macros

note_error_tera_template

Macro to construct a NoteError::TeraTemplate from a Tera::Error` .