Enum LockingHint 

pub enum LockingHint {
    NodeLocal,
    RequireGlobal,
    PreferGlobal,
}

Hint to the scheduler about distributed-locking requirements.

Single-node deployments can ignore this field. Multi-node deployments use it, in combination with a configured crate::locking::LockingPlugin, to decide which instance fires each schedule.

How the host uses the hint

The Locking capability shipped in E2 as crate::locking::LockingPlugin. The host-owned scheduler in bext-core::scheduler consults this field at each tick:

• LockingHint::NodeLocal — skip locking entirely; every node may fire its own copy.
• LockingHint::RequireGlobal — call LockingPlugin::try_lock keyed on schedule_id before invoking ScheduledPlugin::run. On Ok(None) another node holds the lock; skip this tick. On Err(..) log and skip.
• LockingHint::PreferGlobal — try the lock as above, but if no LockingPlugin is configured fall back to NodeLocal behavior rather than failing the install.

Performing the acquisition lives in bext-core::scheduler and is tracked separately from this trait-level doc. The shape, however, is stable: plugins declare the hint once, the host does the rest.

Variants

NodeLocal

No coordination needed — every node may fire its own copy. Use for per-node maintenance like local cache GC.

RequireGlobal

The scheduler should hold a cluster-wide lock for the duration of the run. Only one node fires per scheduled tick. Default for most business logic.

PreferGlobal

Best-effort cluster coordination — try to acquire a global lock, fall back to node-local if the Locking capability is not configured. Lets a plugin work correctly in both single-node and multi-node deployments without hard-failing the install.

Trait Implementations

impl Clone for LockingHint

fn clone(&self) -> LockingHint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LockingHint

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

Formats the value using the given formatter.

impl Default for LockingHint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LockingHint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LockingHint

fn eq(&self, other: &LockingHint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LockingHint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for LockingHint

impl Eq for LockingHint

impl StructuralPartialEq for LockingHint