beep_authz::authzed::api::v1::schema_service_client

Struct SchemaServiceClient

pub struct SchemaServiceClient<T> { /* private fields */ }

Expand description

SchemaService implements operations on a Permissions System’s Schema.

Implementations§

Source §

impl SchemaServiceClient<Channel>

Source

pub async fn connect<D>(dst: D) -> Result<Self, Error>
where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

Source §

impl<T> SchemaServiceClient<T>
where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

Source

pub fn new(inner: T) -> Self

Source

pub fn with_origin(inner: T, origin: Uri) -> Self

Source

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> SchemaServiceClient<InterceptedService<T, F>>
where F: Interceptor, T::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<StdError> + Send + Sync,

Source

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

Source

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

Source

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

Source

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

Source

pub async fn read_schema( &mut self, request: impl IntoRequest<ReadSchemaRequest>, ) -> Result<Response<ReadSchemaResponse>, Status>

Read returns 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

Source

pub async fn write_schema( &mut self, request: impl IntoRequest<WriteSchemaRequest>, ) -> Result<Response<WriteSchemaResponse>, Status>

Write overwrites the current Object Definitions for a Permissions System.

Source

pub async fn reflect_schema( &mut self, request: impl IntoRequest<ReflectSchemaRequest>, ) -> Result<Response<ReflectSchemaResponse>, Status>

ReflectSchema reflects the current schema stored in SpiceDB, returning a structural form of the schema for use by client tooling.

Source

pub async fn computable_permissions( &mut self, request: impl IntoRequest<ComputablePermissionsRequest>, ) -> Result<Response<ComputablePermissionsResponse>, Status>

ComputablePermissions returns the set of permissions that compute based off a relation in the current schema. For example, if the schema has a relation viewer and a permission view defined as permission view = viewer + editor, then the computable permissions for the relation viewer will include view.

Source

pub async fn dependent_relations( &mut self, request: impl IntoRequest<DependentRelationsRequest>, ) -> Result<Response<DependentRelationsResponse>, Status>

DependentRelations returns the set of relations and permissions that used to compute a permission, recursively, in the current schema. It is the inverse of the ComputablePermissions API.

Source