Struct odra_modules::security::Pauseable

pub struct Pauseable { /* private fields */ }

The Pauseable module.

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 HasEvents for Pauseable

fn events() -> Vec<Event>

Returns a list of Events used by the contract.

fn event_schemas() -> BTreeMap<String, Schema>

Returns a map of event schemas used by the contract.

impl HasIdent for Pauseable

fn ident() -> String

Returns the contract’s ident.

impl Module for Pauseable

fn new(env: Rc<ContractEnv>) -> Self

Creates a new instance of the module with the given contract environment.

fn env(&self) -> Rc<ContractEnv>

Returns the contract environment associated with the module.

impl SchemaErrors for Pauseable

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl SchemaEvents for Pauseable

fn schema_events() -> Vec<Event>

Returns a vector of Events.

fn custom_types() -> Vec<Option<CustomType>>

Returns a vector of CustomTypes.