Enum UserPrivilege 

pub enum UserPrivilege {
    Abort,
    ConfigAdapter,
    ConfigApp,
    ConfigDatabase,
    ConfigEngine,
    ConfigModel,
    ConfigReport,
    Configure,
    CtrlExecFlow,
    Debug,
    Develop,
    EditProcessModelFiles,
    EditRuntimeVariables,
    EditSequenceFiles,
    EditStationGlobals,
    EditTemplates,
    EditTypes,
    EditUsers,
    EditWorkspace,
    Execute,
    GrantAll,
    LoopSelectedTests,
    Operate,
    RunAnySequence,
    RunSelectedTests,
    SaveSequenceFiles,
    SinglePass,
    Terminate,
    UseSourceControl,
}

A built-in privilege, as passed to a privilege check.

The engine identifies privileges by name, so this enum exists to stop a caller mistyping one into a check that then silently reports false.

Note that the constant and the value it carries are not always the same word: CtrlExecFlow is written ControlExecFlow on the wire. Using this type rather than a literal avoids having to remember which is which.

Variants

Abort

Abort.

ConfigAdapter

ConfigAdapter.

ConfigApp

ConfigApp.

ConfigDatabase

ConfigDatabase.

ConfigEngine

ConfigEngine.

ConfigModel

ConfigModel.

ConfigReport

ConfigReport.

Configure

Configure.

CtrlExecFlow

CtrlExecFlow.

Debug

Debug.

Develop

Develop.

EditProcessModelFiles

EditProcessModelFiles.

EditRuntimeVariables

EditRuntimeVariables.

EditSequenceFiles

EditSequenceFiles.

EditStationGlobals

EditStationGlobals.

EditTemplates

EditTemplates.

EditTypes

EditTypes.

EditUsers

EditUsers.

EditWorkspace

EditWorkspace.

Execute

Execute.

GrantAll

GrantAll.

LoopSelectedTests

LoopSelectedTests.

Operate

Operate.

RunAnySequence

RunAnySequence.

RunSelectedTests

RunSelectedTests.

SaveSequenceFiles

SaveSequenceFiles.

SinglePass

SinglePass.

Terminate

Terminate.

UseSourceControl

UseSourceControl.

Implementations

impl UserPrivilege

pub const ALL: [Self; 29]

Every built-in privilege.

pub const fn name(self) -> &'static str

The name the engine expects.

A privilege can also be named by its full path, such as Debug.RunSelectedTests; this returns the base name.

Examples found in repository

examples/users_manage.rs (line 22)

fn report_privileges(user: &User, privileges: &[UserPrivilege]) -> Result<(), rs_teststand::Error> {
    for privilege in privileges {
        // has_privilege answers for the user *and* any group they belong to.
        println!(
            "    {:<20} {}",
            privilege.name(),
            user.has_privilege(*privilege)?
        );
    }
    Ok(())
}

Trait Implementations

impl Clone for UserPrivilege

fn clone(&self) -> UserPrivilege

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UserPrivilege

impl Debug for UserPrivilege

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

Formats the value using the given formatter.

impl Eq for UserPrivilege

impl Hash for UserPrivilege

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 UserPrivilege

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UserPrivilege