Struct SpicedbClient 

pub struct SpicedbClient {
    pub channel: Channel,
    /* private fields */
}

SpiceDB client

Fields

channel: Channel

Implementations

impl SpicedbClient

pub async fn from_url_and_preshared_key( url: impl Into<Bytes>, preshared_key: impl ToString, ) -> Result<Self>

Create a new SpicedbClient from the server URL and a preshared key.

let mut client =
    SpicedbClient::from_url_and_preshared_key("http://localhost:50051", "spicedb")
        .await
        .unwrap();

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

Read the current Object Definitions for a Permissions System.

Errors include:

• INVALID_ARGUMENT: a provided value has failed to semantically validate
• NOT_FOUND: no schema has been defined

pub async fn write_schema( &mut self, schema: impl ToString, ) -> Result<WriteSchemaResponse>

Overwrite the current Object Definitions for a Permissions System.

pub async fn read_relationships( &mut self, request: ReadRelationshipsRequest, ) -> Result<Streaming<ReadRelationshipsResponse>>

Read a set of the relationships matching one or more filters.

pub async fn write_relationships( &mut self, request: WriteRelationshipsRequest, ) -> Result<WriteRelationshipsResponse>

Atomically write and/or delete a set of specified relationships. An optional set of preconditions can be provided that must be satisfied for the operation to commit.

pub async fn delete_relationships( &mut self, request: DeleteRelationshipsRequest, ) -> Result<DeleteRelationshipsResponse>

Atomically bulk delete all relationships matching the provided filter. If no relationships match, none will be deleted and the operation will succeed. An optional set of preconditions can be provided that must be satisfied for the operation to commit.

pub async fn check_permission( &mut self, request: CheckPermissionRequest, ) -> Result<CheckPermissionResponse>

Determine, for a given resource, whether a subject computes to having a permission or is a direct member of a particular relation.

pub async fn check_bulk_permissions( &mut self, request: CheckBulkPermissionsRequest, ) -> Result<CheckBulkPermissionsResponse>

Evaluate the given list of permission checks.

pub async fn expand_permission_tree( &mut self, request: ExpandPermissionTreeRequest, ) -> Result<ExpandPermissionTreeResponse>

Reveal the graph structure for a resource’s permission or relation. This RPC does not recurse infinitely deep and may require multiple calls to fully unnest a deeply nested graph.

pub async fn lookup_resources( &mut self, request: LookupResourcesRequest, ) -> Result<Streaming<LookupResourcesResponse>>

Return all the resources of a given type that a subject can access whether via a computed permission or relation membership.

pub async fn lookup_subjects( &mut self, request: LookupSubjectsRequest, ) -> Result<Streaming<LookupSubjectsResponse>>

Return all the subjects of a given type that have access whether via a computed permission or relation membership.

pub async fn watch( &mut self, request: WatchRequest, ) -> Result<Streaming<WatchResponse>>

Watch the database for mutations.

SpiceDB’s Watch API requires commit timestamp tracking be enabled for PostgreSQL and the experimental changefeed for CockroachDB.

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.