Struct spicedb_rust::spicedb::RelationshipFilter

pub struct RelationshipFilter {
    pub resource_type: String,
    pub optional_resource_id: String,
    pub optional_resource_id_prefix: String,
    pub optional_relation: String,
    pub optional_subject_filter: Option<SubjectFilter>,
}

RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields.

All fields are optional and if left unspecified will not filter relationships, but at least one field must be specified.

NOTE: The performance of the API will be affected by the selection of fields on which to filter. If a field is not indexed, the performance of the API can be significantly slower.

Fields

resource_type: String

resource_type is the optional resource type of the relationship. NOTE: It is not prefixed with “optional_” for legacy compatibility.

optional_resource_id: String

optional_resource_id is the optional resource ID of the relationship. If specified, optional_resource_id_prefix cannot be specified.

optional_resource_id_prefix: String

optional_resource_id_prefix is the optional prefix for the resource ID of the relationship. If specified, optional_resource_id cannot be specified.

optional_relation: String

relation is the optional relation of the relationship.

optional_subject_filter: Option<SubjectFilter>

optional_subject_filter is the optional filter for the subjects of the relationships.

Trait Implementations

impl Clone for RelationshipFilter

fn clone(&self) -> RelationshipFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelationshipFilter

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

Formats the value using the given formatter.

impl Default for RelationshipFilter

fn default() -> Self

Returns the “default value” for a type.

impl Message for RelationshipFilter

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for RelationshipFilter

fn eq(&self, other: &RelationshipFilter) -> 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 RelationshipFilter