Struct edgedb_tokio::state::GlobalsModifier

pub struct GlobalsModifier<'a> { /* private fields */ }

Utility object used to modify globals

This object is passed to Fn closure and GlobalsDelta::apply.

Implementations

impl GlobalsModifier<'_>

pub fn set<T: QueryArg>(&mut self, key: &str, value: T)

Set global variable to a value

If key doesn’t contain module name (:: to be more specific) then the variable name is resolved using current module. Otherwise, modules are resolved using aliases if any. Note: modules are resolved at method call time. This means that a sequence like this:

let conn = conn
    .with_globals_fn(|m| m.set("var1", "value1"))
    .with_default_module(Some("another_module"))
    .with_globals_fn(|m| m.set("var1", "value2"));

Will set var1 in default and in another_module to different values.

Panics

This methods panics if value cannot be converted into dynamically typed Value (QueryArg::to_value() method returns error). To avoid this panic use either native EdgeDB types (e.g. edgedb_protocol::model::Datetime instead of std::time::SystemTime or call to_value manually before passing to set.

pub fn unset(&mut self, key: &str)

Unset the global variable

In most cases this will effectively set the variable to a default value.

To set variable to the actual empty value use set("name", Value::Nothing).

Note: same namespacing rules like for set are applied here.

Trait Implementations

impl<'a> Debug for GlobalsModifier<'a>

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

Formats the value using the given formatter.