Struct Auth

#[non_exhaustive]
pub struct Auth { /* private fields */ }

Specifies the current authentication for the datastore execution context.

Implementations

impl Auth

pub fn new(actor: Actor) -> Self

pub fn id(&self) -> &str

pub fn level(&self) -> &Level

Return current authentication level

pub fn is_anon(&self) -> bool

Check if the current auth is anonymous

pub fn is_root(&self) -> bool

Check if the current level is Root

pub fn is_ns(&self) -> bool

Check if the current level is Namespace

pub fn is_db(&self) -> bool

Check if the current level is Database

pub fn is_record(&self) -> bool

Check if the current level is Record

pub fn is_ns_check(&self, ns: &str) -> bool

Check if the current level is Namespace, and the namespace matches

pub fn is_db_check(&self, ns: &str, db: &str) -> bool

Check if the current level is Database, and the namespace and database match

pub fn for_root(role: Role) -> Self

System Auth helpers

These are not stored in the database and are used for internal operations Do not use for authentication

pub fn for_ns(role: Role, ns: &str) -> Self

pub fn for_db(role: Role, ns: &str, db: &str) -> Self

pub fn for_record(rid: String, ns: &str, db: &str, ac: &str) -> Self

pub fn is_allowed(&self, action: Action, res: &Resource) -> Result<(), Error>

Checks if the current auth is allowed to perform an action on a given resource

pub fn has_role(&self, role: Role) -> bool

Checks if the current actor has a given role

pub fn has_editor_role(&self) -> bool

Checks if the current actor has a Editor role

pub fn has_viewer_role(&self) -> bool

Checks if the current actor has a Viewer role

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl Default for Auth

fn default() -> Auth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Auth

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(&DefineAccessStatement, Level)> for Auth

fn from(val: (&DefineAccessStatement, Level)) -> Self

Converts to this type from the input type.

impl Hash for Auth

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 Auth

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

fn partial_cmp(&self, other: &Auth) -> 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 Revisioned for Auth

fn revision() -> u16

Returns the current revision of this type.

fn serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specficifed writer.

fn deserialize_revisioned<R: Read>(reader: &mut R) -> Result<Self, Error>

Deserializes a new instance of the struct from the specficifed reader.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl Serialize for Auth

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(&DefineUserStatement, Level)> for Auth

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: (&DefineUserStatement, Level)) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Auth

impl StructuralPartialEq for Auth