SystemActor

Enum SystemActor 

Source
pub enum SystemActor {
    Beginner,
    SubscriptionsManager,
    UsersManager,
    AccountManager,
    GuestsManager,
    GatewayManager,
    SystemManager,
    TenantOwner,
    TenantManager,
    Service,
    CustomRole(String),
}
Expand description

This is a re-exportation from the myc core to allow users to import both from myc-http-tools instead of the myc-core. The System Actors

Standard actors used to validate operations during the authorization process in system use-cases.

Variants§

§

Beginner

Beginner

This actor is used when no role is assigned to the user.

§

SubscriptionsManager

Subscriptions manager

This actor is responsible for managing subscriptions accounts.

§

UsersManager

Users account manager

This actor is responsible for managing users accounts.

§

AccountManager

Account manager

This actor is responsible for managing a single subscription account.

§

GuestsManager

Guest manager

This actor is responsible for managing roles, guest-roles, and guest-users.

§

GatewayManager

Gateway manager

This actor is responsible for managing gateway endpoints and related configurations.

§

SystemManager

System manager

This actor is responsible for managing system, including error messages, webhooks, and others.

§

TenantOwner

Tenant owner

This actor is responsible for managing tenant metadata, tags, and owner.

WARNING: This is not a role in the system. Don’t use to filter licensed resource scopes during the profile checking.

❌ Wrong example:

use myc_core::domain::dtos::profile::Profile;
use myc_core::domain::actors::SystemActor;
use uuid::Uuid;

let profile = Profile::default();
let tenant_id = Uuid::new_v4();

let related_accounts = profile
    .on_tenant(tenant_id)
    .with_system_accounts_access()
    .with_write_access()
    .with_roles(vec![
        SystemActor::TenantOwner,
        SystemActor::TenantManager,
        SystemActor::SubscriptionsManager,
    ])
    .get_related_account_or_error();

This way should check if the profile has access to the tenant as a guest role. However, tenant owner should be guest as a ownership not as a licensed resource.

✅ Right example:

use myc_core::domain::dtos::profile::Profile;
use myc_core::domain::actors::SystemActor;
use myc_core::domain::dtos::guest_role::Permission;
use uuid::Uuid;

let profile = Profile::default();
let tenant_id = Uuid::new_v4();

let related_accounts = profile
    .on_tenant(tenant_id)
    .with_system_accounts_access()
    .with_write_access()
    .with_roles(vec![
        SystemActor::TenantManager,
        SystemActor::SubscriptionsManager,
    ])
    .get_related_accounts_or_tenant_wide_permission_or_error(tenant_id, Permission::Write);

This way should check if the profile has ownership over the tenant.

§

TenantManager

Tenant manager

This actor is responsible for managing tenants.

§

Service

Service

This is a service entity.

§

CustomRole(String)

Custom role

Implementations§

Source§

impl SystemActor

Source

pub fn str(&self) -> &str

Trait Implementations§

Source§

impl Clone for SystemActor

Source§

fn clone(&self) -> SystemActor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SystemActor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SystemActor

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<SystemActor, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for SystemActor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for SystemActor

Source§

type Err = ()

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<SystemActor, ()>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for SystemActor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SystemActor

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl ToSchema for SystemActor

Source§

fn name() -> Cow<'static, str>

Return name of the schema. Read more
Source§

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type. Read more
Source§

impl Eq for SystemActor

Source§

impl StructuralPartialEq for SystemActor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PartialSchema for T
where T: ComposeSchema + ?Sized,

Source§

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> CloneAny for T
where T: Any + Clone,

Source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

Source§

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Interface for T
where T: Any + Send + Sync,

Source§

impl<T> ModuleInterface for T
where T: Any + Send + Sync,