Struct emacs::OnceGlobalRef

pub struct OnceGlobalRef { /* private fields */ }

A GlobalRef that can be initialized once. This is useful for long-lived values that should be initialized when the dynamic module is loaded. A typical use case is specifying frequently-used symbols, which can be done with the help of the macro use_symbols!.

Implementations

impl OnceGlobalRef

pub const fn new() -> Self

Methods from Deref<Target = GlobalRef>

pub fn call<'e, A>(&'e self, env: &'e Env, args: A) -> Result<Value<'_>>

where A: IntoLispArgs<'e>,

Calls this reference’s value with the given arguments. An error is signaled if it is actually not a Lisp’s callable.

args should be an array/slice of Value, or a tuple of different types, each implementing IntoLisp.

pub unsafe fn call_unprotected<'e, A>( &'e self, env: &'e Env, args: A ) -> Result<Value<'_>>

where A: IntoLispArgs<'e>,

Like call, except that the returned Value is not protected against Emacs GC’s bug #31238, which caused issue #2.

Safety

This can be used as an optimization, in situations when the returned Value is unused, or when its usage is shorter than the lifespan of the underlying Lisp object.

pub fn bind<'e, 'g: 'e>(&'g self, env: &'e Env) -> Value<'e>

Returns the underlying Value, scoping its lifetime to the given Env.

pub fn clone(&self, env: &Env) -> Self

Returns a copy of this global reference.

Trait Implementations

impl Debug for OnceGlobalRef

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

Formats the value using the given formatter.

impl Deref for OnceGlobalRef

type Target = GlobalRef

The resulting type after dereferencing.

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

Dereferences the value.

impl<'e> IntoLisp<'e> for &'e OnceGlobalRef

fn into_lisp(self, env: &'e Env) -> Result<Value<'e>>