Enum bit_roles::RoleValue

pub enum RoleValue<T>
where
    T: RoleVariant,
{
    Role(T),
    Raw(usize),
}

The enum holding value of a role.

Variants

Role(T)

Variant that can accept role enum variants.

Raw(usize)

Variant that can accept literal integer values.

Implementations

impl<T> RoleValue<T>

where T: RoleVariant,

pub fn from_role(role: T) -> Self

Creates a new RoleValue instance from a role without performing the validation.

Examples

use bit_roles::{
    BitRole,
    RoleValue,
};

#[derive(Debug, BitRole, Copy, Clone)]
enum MyRole {
    None = 0,
    Staff = 1,
}

let value = RoleValue::from_role(MyRole::Staff);

assert_eq!(value, RoleValue::Role(MyRole::Staff));

• role - The role variant.

pub fn try_from_role(role: T) -> Result<Self, RoleError>

Validates a role and creates a new RoleValue instance from a it.

Examples

use bit_roles::{
    BitRole,
    RoleValue,
};

#[derive(Debug, BitRole, Copy, Clone)]
enum MyRole {
    None = 0,
    Staff = 1,
}

let value = RoleValue::try_from_role(MyRole::Staff).expect("invalid role");

assert_eq!(value, RoleValue::Role(MyRole::Staff));

• role - The role variant.

pub fn from_usize(value: usize) -> Self

Creates a new RoleValue instance from an integer value without performing the validation.

Examples

use bit_roles::{
    BitRole,
    RoleValue,
};

#[derive(Debug, BitRole, Copy, Clone)]
enum MyRole {
    None = 0,
    Staff = 1,
}

let value: RoleValue<MyRole> = RoleValue::from_usize(4);

assert_eq!(value, RoleValue::Raw(4));

• value - The magnitude.

pub fn try_from_usize(value: usize) -> Result<Self, RoleError>

Validates an integer value and creates a new RoleValue instance from it.

Examples

use bit_roles::{
    BitRole,
    RoleValue,
};

#[derive(Debug, BitRole, Copy, Clone)]
enum MyRole {
    None = 0,
    Staff = 1,
}

let value: RoleValue<MyRole> = RoleValue::try_from_usize(4).expect("invalid value");

assert_eq!(value, RoleValue::Raw(4));

• value - The magnitude.

Trait Implementations

impl<T> Clone for RoleValue<T>

where T: RoleVariant + Clone,

fn clone(&self) -> RoleValue<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RoleValue<T>

where T: RoleVariant + Debug,

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

Formats the value using the given formatter.

impl<T> From<RoleValue<T>> for usize

where T: RoleVariant,

fn from(val: RoleValue<T>) -> Self

Converts to this type from the input type.

impl<T> PartialEq for RoleValue<T>

where T: RoleVariant,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Copy for RoleValue<T>

where T: RoleVariant + Copy,

impl<T> Eq for RoleValue<T>

where T: RoleVariant,