Struct rink_core::context::Context

pub struct Context {

    pub dimensions: BTreeSet<Dimension>,
    pub canonicalizations: BTreeMap<String, String>,
    pub units: BTreeMap<String, Number>,
    pub quantities: BTreeMap<Quantity, String>,
    pub reverse: BTreeMap<Quantity, String>,
    pub prefixes: Vec<(String, Number)>,
    pub definitions: BTreeMap<String, Expr>,
    pub docs: BTreeMap<String, String>,
    pub categories: BTreeMap<String, String>,
    pub category_names: BTreeMap<String, String>,
    pub datepatterns: Vec<Vec<DatePattern>>,
    pub substances: BTreeMap<String, Substance>,
    pub substance_symbols: BTreeMap<String, String>,
    pub temporaries: BTreeMap<String, Number>,
    pub now: DateTime<Local>,
    pub short_output: bool,
    pub use_humanize: bool,
    pub save_previous_result: bool,
    pub previous_result: Option<Number>,
}

The evaluation context that contains unit definitions.

Fields

dimensions: BTreeSet<Dimension>

canonicalizations: BTreeMap<String, String>

units: BTreeMap<String, Number>

quantities: BTreeMap<Quantity, String>

reverse: BTreeMap<Quantity, String>

prefixes: Vec<(String, Number)>

definitions: BTreeMap<String, Expr>

docs: BTreeMap<String, String>

categories: BTreeMap<String, String>

category_names: BTreeMap<String, String>

datepatterns: Vec<Vec<DatePattern>>

substances: BTreeMap<String, Substance>

substance_symbols: BTreeMap<String, String>

temporaries: BTreeMap<String, Number>

now: DateTime<Local>

short_output: bool

use_humanize: bool

save_previous_result: bool

previous_result: Option<Number>

Implementations

impl Context

pub fn new() -> Context

Creates a new, empty context

pub fn set_time(&mut self, time: DateTime<Local>)

pub fn update_time(&mut self)

pub fn load_dates(&mut self, dates: Vec<Vec<DatePattern>>)

pub fn lookup(&self, name: &str) -> Option<Number>

Given a unit name, returns its value if it exists. Supports SI prefixes, plurals, bare dimensions like length, and quantities.

pub fn canonicalize(&self, name: &str) -> Option<String>

Given a unit name, try to return a canonical name (expanding aliases and such)

pub fn describe_unit(&self, value: &Number) -> (bool, String)

Describes a value’s unit, gives true if the unit is reciprocal (e.g. you should prefix “1.0 / “ or replace “multiply” with “divide” when rendering it).

pub fn typo_dym<'a>(&'a self, what: &str) -> Option<&'a str>

pub fn unknown_unit_err(&self, name: &str) -> NotFoundError

impl Context

pub fn humanize<Tz: TimeZone>(&self, date: DateTime<Tz>) -> Option<String>

impl Context

pub fn eval(&self, expr: &Expr) -> Result<Value, QueryError>

Evaluates an expression to compute its value, excluding -> conversions.

pub fn eval_unit_name(
    &self,
    expr: &Expr
) -> Result<(BTreeMap<String, isize>, Numeric), QueryError>

pub fn show(
    &self,
    raw: &Number,
    bottom: &Number,
    bottom_name: BTreeMap<String, isize>,
    bottom_const: Numeric,
    base: u8,
    digits: Digits
) -> ConversionReply

pub fn eval_outer(&self, expr: &Query) -> Result<QueryReply, QueryError>

Evaluates an expression, include -> conversions.

impl Context

pub fn load(&mut self, defs: Defs)

Takes a parsed definitions.units from gnu_units::parse(). Prints if there are errors in the file.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Equivalent to Context::new()