Skip to main content

AccessContext

Struct AccessContext 

Source
pub struct AccessContext {
    pub user_id: Option<String>,
    pub groups: Vec<String>,
    pub organization_id: Option<String>,
}
Expand description

The identity a retrieval is performed as — the requester’s entitlements.

Built from the authenticated user and the groups they belong to (resolved upstream from the auth context). Passed into the knowledge-retrieval path so results can be filtered by AccessContext::can_access.

§Org scoping (organization_id)

The within-org user/group ACL (can_access) is the operator’s single-tenant default and does not consult the org. A multi-tenant relational host (e.g. SmooAI), however, needs the turn’s org to scope RAG to that tenant’s documents — its StorageAdapter::knowledge_for_access reads access.organization_id to pick the right tenant before any user/group filtering. So the org rides on the AccessContext purely to be available to a host adapter; the built-in ACL path ignores it (org isolation already happened upstream — every knowledge row carries an organizationId the backend filters on). None ⇒ “no org resolved”, which a single-tenant adapter treats exactly as today.

Fields§

§user_id: Option<String>

The requester’s user id, if authenticated as a user. None for an anonymous / system requester (which then only sees public + no-ACL docs).

§groups: Vec<String>

The groups the requester belongs to.

§organization_id: Option<String>

The organization this turn is scoped to, when resolved. Carried so a multi-tenant host adapter’s knowledge_for_access can scope retrieval to the right tenant; the operator’s built-in ACL ignores it (see the type-level “Org scoping” note). None when no org is resolved (the single-tenant / anonymous default).

Implementations§

Source§

impl AccessContext

Source

pub fn new(user_id: Option<String>, groups: Vec<String>) -> Self

Build a context from an optional user id and a set of groups. The org is left unset (None); use with_organization_id to attach the turn’s org for a multi-tenant host.

Source

pub fn for_user(user_id: impl Into<String>) -> Self

A context for a specific user with no group memberships.

Source

pub fn anonymous() -> Self

An anonymous requester: no user id, no groups. Sees only public and no-ACL (org-public) documents.

Source

pub fn with_group(self, group: impl Into<String>) -> Self

Add a group membership (builder).

Source

pub fn with_organization_id(self, organization_id: impl Into<String>) -> Self

Attach the turn’s organization (builder). Carried so a multi-tenant host adapter’s knowledge_for_access can scope retrieval to that tenant. The operator’s built-in ACL ignores it (see the type-level “Org scoping” note), so this is behavior-preserving for the single-tenant default.

Source

pub fn can_access(&self, acl: &DocAcl) -> bool

Whether this requester may read a document with the given DocAcl.

true when the doc is public, or the requester’s user id is in the allow-list, or any of the requester’s groups is in the allow-list.

Trait Implementations§

Source§

impl Clone for AccessContext

Source§

fn clone(&self) -> AccessContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccessContext

Source§

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

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

impl Default for AccessContext

Source§

fn default() -> AccessContext

Returns the “default value” for a type. Read more
Source§

impl Eq for AccessContext

Source§

impl PartialEq for AccessContext

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for AccessContext

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> State for T
where T: Clone + Send + Sync + 'static,

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, 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