Enum Role 

pub enum Role {
    Public,
    Internal,
    Developer,
}

Role visibility for documentation generation

Controls who sees this error in generated documentation.

Variants

Public

Visible to all users (library consumers, end users)

Internal

Visible only to team members (internal documentation)

Developer

Visible only to library/compiler developers

Implementations

impl Role

pub fn privilege_level(&self) -> u8

Returns the privilege level for hierarchical comparisons.

Lower numbers are more restrictive:

• Public: 0 (most restrictive)
• Developer: 1
• Internal: 2 (least restrictive, sees everything)

pub fn can_view(&self, content_role: Option<Role>) -> bool

Check if this role can view content marked with the given role.

Visibility is hierarchical:

• Public can only see Public content
• Developer can see Public and Developer content
• Internal can see all content
• Content with None (unspecified) is visible to everyone

Examples

use waddling_errors::traits::Role;

assert!(Role::Public.can_view(Some(Role::Public)));
assert!(!Role::Public.can_view(Some(Role::Internal)));
assert!(Role::Internal.can_view(Some(Role::Public)));
assert!(Role::Developer.can_view(None)); // Unspecified visible to all

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl Hash for Role

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Role

fn eq(&self, other: &Role) -> 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 Copy for Role

impl Eq for Role

impl StructuralPartialEq for Role