Struct RoleSymbol 

pub struct RoleSymbol(/* private fields */);

Represents a role symbol for role-based access control.

Role symbols can consist of up to 12 uppercase Latin characters and underscores, e.g. “MINTER”, “BURNER”, “MINTER_ADMIN”.

The label is stored internally as a validated short string (A–Z and _) and can be converted to a Felt encoding via as_element().

Implementations

impl RoleSymbol

pub const ALPHABET: &'static str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ_"

Alphabet used for role symbols (A-Z and _).

pub const MIN_ENCODED_VALUE: u64 = 1

The minimum integer value of an encoded RoleSymbol.

This value encodes the “A” role symbol.

pub const MAX_ENCODED_VALUE: u64 = 4052555153018976252

The maximum integer value of an encoded RoleSymbol.

This value encodes the “____________” role symbol (12 underscores).

pub fn new_unchecked(role_symbol: &str) -> RoleSymbol

Constructs a new RoleSymbol from a string, panicking on invalid input.

Panics

Panics if:

• The length of the provided string is less than 1 or greater than 12.
• The provided role symbol contains characters outside A-Z and _.

pub fn new(role_symbol: &str) -> Result<RoleSymbol, RoleSymbolError>

Creates a new RoleSymbol from the provided role symbol string.

Errors

Returns an error if:

• The length of the provided string is less than 1 or greater than 12.
• The provided role symbol contains characters outside A-Z and _.

pub fn as_element(&self) -> Felt

Returns the Felt encoding of this role symbol.

Trait Implementations

impl Clone for RoleSymbol

fn clone(&self) -> RoleSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoleSymbol

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for RoleSymbol

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for RoleSymbol

impl From<&RoleSymbol> for Felt

fn from(role_symbol: &RoleSymbol) -> Felt

Converts to this type from the input type.

impl From<RoleSymbol> for Felt

fn from(role_symbol: RoleSymbol) -> Felt

Converts to this type from the input type.

impl Ord for RoleSymbol

fn cmp(&self, other: &RoleSymbol) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RoleSymbol

fn eq(&self, other: &RoleSymbol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RoleSymbol

fn partial_cmp(&self, other: &RoleSymbol) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RoleSymbol

impl TryFrom<&str> for RoleSymbol

type Error = RoleSymbolError

The type returned in the event of a conversion error.

fn try_from( role_symbol: &str, ) -> Result<RoleSymbol, <RoleSymbol as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Felt> for RoleSymbol

fn try_from( felt: Felt, ) -> Result<RoleSymbol, <RoleSymbol as TryFrom<Felt>>::Error>

Decodes a Felt representation of the role symbol into a RoleSymbol.

type Error = RoleSymbolError

The type returned in the event of a conversion error.