Struct CheckDebugTrace 

pub struct CheckDebugTrace {
    pub resource: Option<ObjectReference>,
    pub permission: String,
    pub permission_type: i32,
    pub subject: Option<SubjectReference>,
    pub result: i32,
    pub caveat_evaluation_info: Option<CaveatEvalInfo>,
    pub duration: Option<Duration>,
    pub optional_expires_at: Option<Timestamp>,
    pub trace_operation_id: String,
    pub source: String,
    pub resolution: Option<Resolution>,
}

CheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.

Fields

resource: Option<ObjectReference>

resource holds the resource on which the Check was performed. for batched calls, the object_id field contains a comma-separated list of object IDs for all the resources checked in the batch.

permission: String

permission holds the name of the permission or relation on which the Check was performed.

permission_type: i32

permission_type holds information indicating whether it was a permission or relation.

subject: Option<SubjectReference>

subject holds the subject on which the Check was performed. This will be static across all calls within the same Check tree.

result: i32

result holds the result of the Check call.

caveat_evaluation_info: Option<CaveatEvalInfo>

caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.

duration: Option<Duration>

duration holds the time spent executing this Check operation.

optional_expires_at: Option<Timestamp>

optional_expires_at is the time at which at least one of the relationships used to compute this result, expires (if any). This is not related to the caching window.

trace_operation_id: String

trace_operation_id is a unique identifier for this trace’s operation, that will be shared for all traces created for the same check operation in SpiceDB.

In cases where SpiceDB performs automatic batching of subproblems, this ID can be used to correlate work that was shared across multiple traces.

This identifier is generated by SpiceDB, is to be considered opaque to the caller and only guaranteed to be unique within the same overall Check or CheckBulk operation.

source: String

source holds the source of the result. It is of the form: <sourcetype>:<sourceid>, where sourcetype can be, among others: spicedb, materialize, etc.

resolution: Option<Resolution>

resolution holds information about how the problem was resolved.

Implementations

impl CheckDebugTrace

pub fn permission_type(&self) -> PermissionType

Returns the enum value of permission_type, or the default if the field is set to an invalid enum value.

pub fn set_permission_type(&mut self, value: PermissionType)

Sets permission_type to the provided enum value.

pub fn result(&self) -> Permissionship

Returns the enum value of result, or the default if the field is set to an invalid enum value.

pub fn set_result(&mut self, value: Permissionship)

Sets result to the provided enum value.

Trait Implementations

impl Clone for CheckDebugTrace

fn clone(&self) -> CheckDebugTrace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckDebugTrace

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

Formats the value using the given formatter.

impl Default for CheckDebugTrace

fn default() -> Self

Returns the “default value” for a type.

impl Message for CheckDebugTrace

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CheckDebugTrace

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CheckDebugTrace