Struct odra_modules::access::OwnableHostRef

impl OwnableHostRef

pub fn init(&mut self)

Initializes the module setting the caller as the initial owner.

pub fn transfer_ownership(&mut self, new_owner: &Address)

Transfers ownership of the module to new_owner. This function can only be accessed by the current owner of the module.

pub fn renounce_ownership(&mut self)

If the contract’s owner chooses to renounce their ownership, the contract will no longer have an owner. This means that any functions that can only be accessed by the owner will no longer be available.

The function can only be called by the current owner, and it will permanently remove the owner’s privileges.

pub fn get_owner(&self) -> Address

Returns the address of the current owner.

pub fn assert_owner(&self, address: &Address)

Reverts with [Error::CallerNotTheOwner] if the function called by any account other than the owner.

pub fn get_optional_owner(&self) -> Option<Address>

Returns the optional address of the current owner.

pub fn unchecked_transfer_ownership(&mut self, new_owner: Option<Address>)

Unchecked version of the ownership transfer. It emits an event and sets the new owner.

impl OwnableHostRef

pub fn try_init(&mut self) -> OdraResult<()>

Initializes the module setting the caller as the initial owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_transfer_ownership(&mut self, new_owner: &Address) -> OdraResult<()>

Transfers ownership of the module to new_owner. This function can only be accessed by the current owner of the module. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_renounce_ownership(&mut self) -> OdraResult<()>

If the contract’s owner chooses to renounce their ownership, the contract will no longer have an owner. This means that any functions that can only be accessed by the owner will no longer be available.

The function can only be called by the current owner, and it will permanently remove the owner’s privileges. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_get_owner(&self) -> OdraResult<Address>

Returns the address of the current owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_assert_owner(&self, address: &Address) -> OdraResult<()>

Reverts with [Error::CallerNotTheOwner] if the function called by any account other than the owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_get_optional_owner(&self) -> OdraResult<Option<Address>>

Returns the optional address of the current owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_unchecked_transfer_ownership( &mut self, new_owner: Option<Address> ) -> OdraResult<()>

Unchecked version of the ownership transfer. It emits an event and sets the new owner. Does not fail in case of error, returns odra::OdraResult instead.

Trait Implementations§

impl EntryPointsCallerProvider for OwnableHostRef

fn entry_points_caller(env: &HostEnv) -> EntryPointsCaller

Returns an [EntryPointsCaller] for the given host environment.

impl HasIdent for OwnableHostRef

fn ident() -> String

Returns the contract’s ident.

impl HostRef for OwnableHostRef

fn new(address: Address, env: HostEnv) -> Self

Creates a new host side reference to a contract.

fn with_tokens(&self, tokens: U512) -> Self

Creates a new host reference with attached tokens, based on the current instance. Read more

fn address(&self) -> &Address

Returns the address of the contract.

fn env(&self) -> &HostEnv

Returns the host environment.

fn get_event<T>(&self, index: i32) -> Result<T, EventError>
where T: FromBytes + EventInstance,

Returns the n-th event emitted by the contract. Read more

fn last_call(&self) -> ContractCallResult

Returns a detailed information about the last call of the contract.

Auto Trait Implementations§

impl !UnwindSafe for OwnableHostRef

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into a target type. Read more

impl<R> Deployer for R
where R: HostRef + EntryPointsCallerProvider + HasIdent,

fn deploy<T>(env: &HostEnv, init_args: T) -> R
where T: InitArgs,

Deploys a contract with given init args. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> HostRefLoader for T
where T: EntryPointsCallerProvider + HostRef,

fn load(env: &HostEnv, address: Address) -> T

Loads an existing contract from the host environment.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pipe for T

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

impl<T> PipeAsRef for T

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: AsRef<T>, T: 'a, R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R
where Self: AsMut<T>, T: 'a, R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeBorrow for T

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Borrow<T>, T: 'a, R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_borrow_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: BorrowMut<T>, T: 'a, R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeDeref for T

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R
where Self: Deref, R: 'a,

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

fn pipe_deref_mut<'a, R>( &'a mut self, func: impl FnOnce(&'a mut Self::Target) -> R ) -> R
where Self: DerefMut, R: 'a,

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

impl<T> PipeRef for T

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap<F, R>(self, func: F) -> Self
where F: FnOnce(&Self) -> R,

Provides immutable access for inspection. Read more

fn tap_dbg<F, R>(self, func: F) -> Self
where F: FnOnce(&Self) -> R,

Calls tap in debug builds, and does nothing in release builds.

fn tap_mut<F, R>(self, func: F) -> Self
where F: FnOnce(&mut Self) -> R,

Provides mutable access for modification. Read more

fn tap_mut_dbg<F, R>(self, func: F) -> Self
where F: FnOnce(&mut Self) -> R,

Calls tap_mut in debug builds, and does nothing in release builds.

impl<T, U> TapAsRef for T
where U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Self
where Self: AsRef<T>, F: FnOnce(&T) -> R,

Provides immutable access to the reference for inspection.

fn tap_ref_dbg<F, R>(self, func: F) -> Self
where Self: AsRef<T>, F: FnOnce(&T) -> R,

Calls tap_ref in debug builds, and does nothing in release builds.

fn tap_ref_mut<F, R>(self, func: F) -> Self
where Self: AsMut<T>, F: FnOnce(&mut T) -> R,

Provides mutable access to the reference for modification.

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self
where Self: AsMut<T>, F: FnOnce(&mut T) -> R,

Calls tap_ref_mut in debug builds, and does nothing in release builds.

impl<T, U> TapBorrow for T
where U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Self
where Self: Borrow<T>, F: FnOnce(&T) -> R,

Provides immutable access to the borrow for inspection. Read more

fn tap_borrow_dbg<F, R>(self, func: F) -> Self
where Self: Borrow<T>, F: FnOnce(&T) -> R,

Calls tap_borrow in debug builds, and does nothing in release builds.

fn tap_borrow_mut<F, R>(self, func: F) -> Self
where Self: BorrowMut<T>, F: FnOnce(&mut T) -> R,

Provides mutable access to the borrow for modification.

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self
where Self: BorrowMut<T>, F: FnOnce(&mut T) -> R,

Calls tap_borrow_mut in debug builds, and does nothing in release builds.

impl<T> TapDeref for T

fn tap_deref<F, R>(self, func: F) -> Self
where Self: Deref, F: FnOnce(&Self::Target) -> R,

Immutably dereferences self for inspection.

fn tap_deref_dbg<F, R>(self, func: F) -> Self
where Self: Deref, F: FnOnce(&Self::Target) -> R,

Calls tap_deref in debug builds, and does nothing in release builds.

fn tap_deref_mut<F, R>(self, func: F) -> Self
where Self: DerefMut, F: FnOnce(&mut Self::Target) -> R,

Mutably dereferences self for modification.

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self
where Self: DerefMut, F: FnOnce(&mut Self::Target) -> R,

Calls tap_deref_mut in debug builds, and does nothing in release builds.

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into a target type. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,