Struct spawn_access_control::RoleManager

pub struct RoleManager { /* private fields */ }

RoleManager: A Library for Managing Ownership and Roles in WASM

RoleManager provides a secure mechanism to manage ownership, roles, and access control in WebAssembly (WASM) environments.

Features:

• Ownership transfer
• Role assignment and removal
• Role-based access control (RBAC)

Usage:

RoleManager is designed to manage contract ownership and roles, ensuring only authorized users can perform certain actions.

Example

let mut role_manager = RoleManager::new("admin");
role_manager.assign_role("admin", "editor", "user1").unwrap();
assert!(role_manager.has_role("editor", "user1"));

Implementations

impl RoleManager

pub fn new(owner: &str) -> RoleManager

Creates a new RoleManager with the specified owner.

Arguments

• owner - A string slice that holds the initial owner of the contract.

Example

let manager = RoleManager::new("admin");

pub fn get_owner(&self) -> String

Returns the current owner of the contract.

Example

let owner = role_manager.get_owner();

pub fn transfer_ownership( &mut self, current_owner: &str, new_owner: &str, ) -> Result<(), String>

Transfers ownership to a new user.

Only the current owner can transfer ownership.

Arguments

• current_owner - The current owner’s ID.
• new_owner - The new owner’s ID.

Returns

• Ok(()) on success.
• Err with a message if the current owner is incorrect.

pub fn assign_role( &mut self, owner: &str, role: &str, user: &str, ) -> Result<(), String>

Assigns a role to a user.

Only the current owner can assign roles.

Arguments

• owner - The current owner’s ID.
• role - The role to be assigned (e.g., “admin”).
• user - The user who will receive the role.

Returns

• Ok(()) on success.
• Err if the user already has the role or if the owner is incorrect.

pub fn remove_role( &mut self, owner: &str, role: &str, user: &str, ) -> Result<(), String>

Removes a role from a user.

Only the current owner can remove roles.

Arguments

• owner - The current owner’s ID.
• role - The role to be removed.
• user - The user from whom the role will be removed.

Returns

• Ok(()) on success.
• Err if the user doesn’t have the role or if the owner is incorrect.

pub fn has_role(&self, role: &str, user: &str) -> bool

Checks if a user has a specific role.

Arguments

• role - The role to check (e.g., “admin”).
• user - The user to check.

Returns

• true if the user has the role.
• false if the user does not have the role.

pub fn is_owner(&self, user: &str) -> Result<bool, String>

Verifies if a user is the owner.

Arguments

• user - The user to check.

Returns

• Ok(true) if the user is the owner.
• Err with a message if the user is not the owner.

pub fn role_based_access(&self, user: &str, role: &str) -> bool

Provides role-based access control.

Arguments

• user - The user requesting access.
• role - The required role for access.

Returns

• true if the user is the owner or has the role.
• false otherwise.

pub fn list_role_users(&self, role: &str) -> Vec<String>

Lists all users for a given role.

Arguments

• role - The role to list users for.

Returns

• A Vec<String> containing all users with the specified role.

Trait Implementations

impl From<RoleManager> for JsValue

fn from(value: RoleManager) -> Self

Converts to this type from the input type.

impl FromWasmAbi for RoleManager

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for RoleManager

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for RoleManager

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<RoleManager>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for RoleManager

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for RoleManager

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for RoleManager

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = RcRef<RoleManager>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for RoleManager

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<RoleManager>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for RoleManager

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for RoleManager

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[RoleManager]>

impl VectorIntoJsValue for RoleManager

fn vector_into_jsvalue(vector: Box<[RoleManager]>) -> JsValue

impl VectorIntoWasmAbi for RoleManager

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[RoleManager]>) -> Self::Abi

impl WasmDescribe for RoleManager

fn describe()

impl WasmDescribeVector for RoleManager

fn describe_vector()