Skip to main content

Principal

Enum Principal 

Source
pub enum Principal {
    User(PrincipalId),
    Component(ComponentId),
    System,
}
Expand description

The actor performing an action.

A Principal represents identity only, not permission level. Permission is determined by the runtime layer’s Session.

§Variants

VariantDescriptionTypical Use
UserHuman userInteractive CLI usage
ComponentAutonomous componentBackground processing
SystemInternal operationsLifecycle, cleanup

§Why Not Just Use ComponentId?

ComponentId identifies what is executing (LLM, Tool, etc.). Principal identifies who initiated the action.

A Tool component may execute a file write, but the Principal is the human user who requested it. This distinction enables:

  • Audit trails attributing actions to users
  • Permission checks based on who initiated
  • Rate limiting per user, not per component

§Example

use orcs_types::{Principal, ComponentId, PrincipalId};

// Human user
let user = Principal::User(PrincipalId::new());

// Component acting autonomously (e.g., scheduled task)
let component = Principal::Component(ComponentId::builtin("scheduler"));

// System internal operation
let system = Principal::System;

Variants§

§

User(PrincipalId)

Human user identified by PrincipalId.

Represents interactive CLI usage or API calls from authenticated users.

§

Component(ComponentId)

Component acting autonomously.

Used when a component initiates actions without direct human involvement, such as:

  • Scheduled background tasks
  • Event-driven reactions
  • Plugin self-maintenance
§

System

System internal operations.

Used for operations that are not attributable to any specific user or component:

  • Lifecycle management (startup, shutdown)
  • Garbage collection
  • Internal housekeeping

Implementations§

Source§

impl Principal

Source

pub fn is_user(&self) -> bool

Returns true if this is a Principal::User.

Source

pub fn is_component(&self) -> bool

Returns true if this is a Principal::Component.

Source

pub fn is_system(&self) -> bool

Returns true if this is Principal::System.

Source

pub fn user_id(&self) -> Option<&PrincipalId>

Returns the PrincipalId if this is a User, otherwise None.

Source

pub fn component_id(&self) -> Option<&ComponentId>

Returns the ComponentId if this is a Component, otherwise None.

Trait Implementations§

Source§

impl Clone for Principal

Source§

fn clone(&self) -> Principal

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 Principal

Source§

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

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

impl<'de> Deserialize<'de> for Principal

Source§

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

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

impl Display for Principal

Source§

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

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

impl PartialEq for Principal

Source§

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

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 Eq for Principal

Source§

impl StructuralPartialEq for Principal

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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,