Enum DeadlockPolicy

pub enum DeadlockPolicy {
    Allow,
    Pessimistic,
    Timeout(Duration),
}

Policies to deal with potential deadlocks

As Godot allows mutable pointer aliasing, doing certain things in exported method bodies may lead to the engine calling another method on owner, leading to another locking attempt within the same thread:

• Variant calls on anything may dispatch to a script method.
• Anything that could emit signals, that are connected to in a non-deferred manner.

As there is no universal way to deal with such situations, behavior of locking wrappers can be customized using this enum.

Variants

Allow

Block on all locks. Deadlocks are possible.

Pessimistic

Never block on any locks. Methods will return Nil immediately if the lock isn’t available. Deadlocks are prevented.

Timeout(Duration)

Block on locks for at most Duration. Methods return Nil on timeout. Deadlocks are prevented.

Trait Implementations

impl Clone for DeadlockPolicy

fn clone(&self) -> DeadlockPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeadlockPolicy

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

Formats the value using the given formatter.

impl Hash for DeadlockPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DeadlockPolicy

fn cmp(&self, other: &DeadlockPolicy) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DeadlockPolicy

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

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

const 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 PartialOrd for DeadlockPolicy

fn partial_cmp(&self, other: &DeadlockPolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DeadlockPolicy

impl Eq for DeadlockPolicy

impl StructuralPartialEq for DeadlockPolicy