Struct texlang::command::StaticTag

pub struct StaticTag(/* private fields */);

A static tag enables creating a tag in a static variable.

static TAG: StaticTag = StaticTag::new();

let first_get = TAG.get();
let second_get = TAG.get();
assert_eq!(first_get, second_get);

Implementations

impl StaticTag

pub const fn new() -> StaticTag

Create a new static tag.

pub fn get(&self) -> Tag

Get the actual Tag out of this StaticTag. Repeated calls to this function return the same tag.

This is not a trivial getter. The Tag is lazily constructed so even subsequent calls to this getter must do some work to check if the Tag exists or not. For very hot code paths it is advised to cache the return value somewhere, for example in a relevant command’s state.