Struct Actor 

pub struct Actor {
    pub id: Uuid,
    pub username: String,
    pub display_name: String,
    pub role: Role,
    pub skin: String,
    pub preferred_cad: String,
    pub projects: Vec<Uuid>,
    pub hidden_projects: Vec<Uuid>,
}

The authenticated user on whose behalf a request is executed.

Fields

id: Uuid

username: String

display_name: String

role: Role

skin: String

UI skin (see domain::SKINS).

preferred_cad: String

Preferred CAD program (a format family, see cadformat::families); "" = show all files alike.

projects: Vec<Uuid>

Project groups the user is a member of.

hidden_projects: Vec<Uuid>

Restricted project groups the user is NOT a member of; always empty for administrators. Never serialized: it names groups the user may not know about. The SQL guards in services::access bind it.

Implementations

impl Actor

pub fn can_see_project(&self, project_id: Option<Uuid>) -> bool

Whether the actor may read data of a project group (None = items without a group, readable by everyone).

pub fn without_groups(self, groups: &[Uuid]) -> Actor

The same actor without the read rights to groups (an interface that is switched off for them, see services::project_policy): they are hidden like groups the user is no member of.

pub fn for_webhook(project_id: Option<Uuid>, restricted: &[Uuid]) -> Actor

A webhook evaluated as a virtual reader: it sees its own group and every internal group; a global webhook (project_id = None) sees internal groups only. restricted = all restricted groups.

pub fn system() -> Actor

The system itself (background workers): sees everything.

pub fn require(&self, min: Role) -> AppResult<()>

Fails with 403 Forbidden unless the actor has at least role min.

pub fn is_admin(&self) -> bool

pub fn can_edit(&self) -> bool

CAD editor or admin (may edit at least somewhere).

pub fn can_edit_project(&self, project_id: Option<Uuid>) -> bool

Whether the actor may modify data of a project group. Admins may edit everything, CAD editors only the projects they are members of; items without a project (legacy data) are editable by every CAD editor.

Trait Implementations

impl Clone for Actor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Actor

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

Formats the value using the given formatter.

impl Serialize for Actor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.