Struct odra_modules::security::Pauseable

pub struct Pauseable { /* private fields */ }

A module allowing to implement an emergency stop mechanism that can be triggered by any account.

You can use this module in a custom module by adding it as a field.

It will make available require_not_paused() and require_paused() functions, which can be used in the functions of your contract to ensure the contract is in the correct state.

Implementations

impl Pauseable

pub fn is_paused(&self) -> bool

Returns true if the contract is paused, and false otherwise.

pub fn require_not_paused(&self)

Reverts with [Error::UnpausedRequired] if the contract is paused.

pub fn require_paused(&self)

Reverts with [Error::PausedRequired] if the contract is paused.

pub fn pause(&mut self)

Changes the state to stopped.

The contract must not be paused.

Emits Paused event.

pub fn unpause(&mut self)

Returns the contract to normal state.

The contract must be paused.

Emits Unpaused event.

Trait Implementations

impl Clone for Pauseable

fn clone(&self) -> Pauseable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DynamicInstance for Pauseable

fn instance(namespace: &[u8]) -> Self

impl Node for Pauseable

const IS_LEAF: bool = false

const COUNT: u32 = 1u32

fn __keys() -> Vec<String>

impl OdraItem for Pauseable

fn is_module() -> bool

impl StaticInstance for Pauseable

fn instance<'a>(keys: &'a [&'a str]) -> (Self, &'a [&'a str])

Consumes keys required to create an instance, returns the instance with the remaining keys.