Struct authzen_core::Event

pub struct Event<Subject, Action: ?Sized, Object: ?Sized, Input, Context = ()> {
    pub subject: Subject,
    pub action: PhantomData<Action>,
    pub object: PhantomData<Object>,
    pub input: Input,
    pub context: Context,
}

The unit of work in an authorization query, which will either be accepted or rejected by a decision maker.

Fields

subject: Subject

the entity performing the action; typically links back to a user / account; could be represented with an account id, a jwt, or even more information if necessary

action: PhantomData<Action>

the action which the subject is trying to perform; typically this will be a struct dervied from the action macro (e.g. Create<MyObject>)

object: PhantomData<Object>

the object wich the subject is attempting to act upon; note that this parameter is only used as a specification of the object’s type and service it belongs to

input: Input

the data provided which uniquely identifies the object(s) being acted upon; the type used here can be anything which is recognized as valid input for the specific action (see StorageAction to see how actions specify their acceptable inputs)

context: Context

any additional data which should or must be provided in order to fulfill the authorization decision; use this for any data which is not referring to objects being acted on

Implementations

impl<Subject, Action: ?Sized, Object: ?Sized, Input, Context> Event<Subject, Action, Object, Input, Context>

pub fn dissolve( self ) -> (Subject, PhantomData<Action>, PhantomData<Object>, Input, Context)

impl<Subject, Action: ?Sized, Object: ?Sized, Input, Context> Event<Subject, Action, Object, Input, Context>

pub fn subject(&self) -> &Subject

pub fn input(&self) -> &Input

pub fn context(&self) -> &Context

impl<Subject, Action: ?Sized, Object: ?Sized, Input, Context> Event<Subject, Action, Object, Input, Context>

pub fn builder( ) -> EventBuilder<((), (), (), (), ()), Subject, Action, Object, Input, Context>

Create a builder for building Event. On the builder, call .subject(...), .action(...), .object(...), .input(...), .context(...) to set the values of the fields. Finally, call .build() to create the instance of Event.

Trait Implementations

impl<Subject, A, Objects, Context> ActionType for Event<Subject, A, Objects, Context>where A: ActionType,

const TYPE: &'static str = A::TYPE

The type name of this action.

impl<Subject: Clone, Action: Clone + ?Sized, Object: Clone + ?Sized, Input: Clone, Context: Clone> Clone for Event<Subject, Action, Object, Input, Context>

fn clone(&self) -> Event<Subject, Action, Object, Input, Context>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Subject, Action, Object, Input, Context> Debug for Event<Subject, Action, Object, Input, Context>where Subject: Debug, Action: ?Sized + ActionType, Object: ?Sized + ObjectType, Input: Debug, Context: Debug,

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

Formats the value using the given formatter.

impl<'de, Subject, Action, Object, Input, Context> Deserialize<'de> for Event<Subject, Action, Object, Input, Context>where Subject: Deserialize<'de>, Action: ActionType + ?Sized, Object: ObjectType + ?Sized, Input: Deserialize<'de>, Context: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<Subject: PartialEq, Action: PartialEq + ?Sized, Object: PartialEq + ?Sized, Input: PartialEq, Context: PartialEq> PartialEq<Event<Subject, Action, Object, Input, Context>> for Event<Subject, Action, Object, Input, Context>

fn eq(&self, other: &Event<Subject, Action, Object, Input, Context>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Subject, Action, Object, Input, Context> Serialize for Event<Subject, Action, Object, Input, Context>where Subject: Serialize, Action: ActionType + ?Sized, Object: ObjectType + ?Sized, Input: Serialize, Context: Serialize,

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

Serialize this value into the given Serde serializer.

impl<Subject: Eq, Action: Eq + ?Sized, Object: Eq + ?Sized, Input: Eq, Context: Eq> Eq for Event<Subject, Action, Object, Input, Context>

impl<Subject, Action: ?Sized, Object: ?Sized, Input, Context> StructuralEq for Event<Subject, Action, Object, Input, Context>

impl<Subject, Action: ?Sized, Object: ?Sized, Input, Context> StructuralPartialEq for Event<Subject, Action, Object, Input, Context>