Struct AccessControlContractRef 

pub struct AccessControlContractRef { /* private fields */ }

AccessControl Contract Ref.

Implementations

impl AccessControlContractRef

pub fn has_role(&self, role: &Role, address: &Address) -> bool

Returns true if account has been granted role.

pub fn get_role_admin(&self, role: &Role) -> Role

Returns the admin role that controls role.

The admin role may be changed using set_admin_role().

pub fn grant_role(&mut self, role: &Role, address: &Address)

Grants role to address.

If the role has been already granted - nothing happens, otherwise RoleGranted event is emitted.

The caller must have role’s admin role.

pub fn revoke_role(&mut self, role: &Role, address: &Address)

Grants role to address.

If the role has been already revoked - nothing happens, otherwise RoleRevoked event is emitted.

The caller must have role’s admin role.

pub fn renounce_role(&mut self, role: &Role, address: &Address)

The function is used to remove a role from the account that initiated the call.

One common way of managing roles is by using grant_role() and revoke_role(). The purpose of revokeRole is to provide a mechanism for revoking privileges from an account in case it gets compromised.

If the account had previously been granted the role, the function will trigger a RoleRevoked event.

Note that only address is authorized to call this function.

Trait Implementations

impl ContractRef for AccessControlContractRef

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

Creates a new instance of the Contract Ref.

fn address(&self) -> &Address

Returns the address of the contract.

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

Creates a new contract reference with attached tokens, based on the current instance.

impl SchemaErrors for AccessControlContractRef

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl SchemaEvents for AccessControlContractRef

fn schema_events() -> Vec<Event>

Returns a vector of Events.

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

Returns a vector of CustomTypes.