Struct SpiceDBClient

pub struct SpiceDBClient { /* private fields */ }

Implementations

impl SpiceDBClient

pub async fn from_env() -> Result<Self>

Reads the following env variables:

• ZED_TOKEN
• ZED_ENDPOINT

pub async fn new( addr: impl Into<String>, token: impl AsRef<str>, ) -> Result<Self>

pub fn leak(self) -> &'static Self

pub fn schema_service_client( &self, ) -> SchemaServiceClient<InterceptedService<Channel, BearerTokenInterceptor>>

pub fn permission_service_client( &self, ) -> PermissionsServiceClient<InterceptedService<Channel, BearerTokenInterceptor>>

pub fn create_relationships_request(&self) -> WriteRelationshipsRequest

pub fn delete_relationships_request<R>(&self) -> DeleteRelationshipsRequest<R>

where R: Resource,

pub fn read_relationships_request(&self) -> ReadRelationshipsRequest

pub fn check_permission_request<R>(&self) -> CheckPermissionRequest<R>

where R: Resource,

pub fn lookup_resources_request<R>(&self) -> LookupResourcesRequest<R>

where R: Resource,

pub fn lookup_subjects_request<S, R>(&self) -> LookupSubjectsRequest<S, R>

where S: Entity, R: Resource,

pub async fn delete_relationships<R>( &self, id: Option<R::Id>, relation: Option<R::Relations>, subject_filter: Option<SubjectFilter>, ) -> Result<ZedToken, Status>

where R: Resource,

pub async fn create_relationships<R, P>( &self, relationships: R, preconditions: P, ) -> Result<ZedToken, Status>

where R: IntoIterator<Item = RelationshipUpdate>, P: IntoIterator<Item = Precondition>,

pub async fn lookup_resources<R>( &self, actor: &impl Actor, permission: R::Permissions, ) -> Result<Vec<R::Id>, Status>

where R: Resource,

Shortcut for the most common use case of looking up resources, to quickly collect all ID’s returned in one call.

pub async fn lookup_resources_at<R>( &self, actor: &impl Actor, permission: R::Permissions, token: ZedToken, ) -> Result<Vec<R::Id>, Status>

where R: Resource,

pub async fn lookup_subjects<S, R>( &self, id: impl Into<R::Id>, permission: R::Permissions, ) -> Result<Vec<S::Id>, Status>

where R: Resource, S: Entity,

pub async fn lookup_subjects_at<S, R>( &self, id: impl Into<R::Id>, permission: R::Permissions, token: ZedToken, ) -> Result<Vec<S::Id>, Status>

where S: Entity, R: Resource,

pub async fn check_permission<R>( &self, actor: &impl Actor, resource_id: impl Into<R::Id>, permission: R::Permissions, ) -> Result<bool, Status>

where R: Resource,

Shortcut for the most common use case of checking a permission for an actor in the system on a specific resource R with default consistency.

pub async fn check_permission_at<R>( &self, actor: &impl Actor, resource_id: impl Into<R::Id>, permission: R::Permissions, token: ZedToken, ) -> Result<bool, Status>

where R: Resource,

pub async fn write_schema(&self, schema: String) -> Result<ZedToken, Status>

pub async fn read_schema(&self) -> Result<ReadSchemaResponse, Status>

Trait Implementations

impl Clone for SpiceDBClient

fn clone(&self) -> SpiceDBClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpiceDBClient

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

Formats the value using the given formatter.