Struct LookupSubjectsRequest 

pub struct LookupSubjectsRequest {
    pub consistency: Option<Consistency>,
    pub resource: Option<ObjectReference>,
    pub permission: String,
    pub subject_object_type: String,
    pub optional_subject_relation: String,
    pub context: Option<Struct>,
    pub optional_concrete_limit: u32,
    pub optional_cursor: Option<Cursor>,
    pub wildcard_option: i32,
}

LookupSubjectsRequest performs a lookup of all subjects of a particular kind for which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those subjects.

Fields

consistency: Option<Consistency>

resource: Option<ObjectReference>

resource is the resource for which all matching subjects for the permission or relation will be returned.

permission: String

permission is the name of the permission (or relation) for which to find the subjects.

subject_object_type: String

subject_object_type is the type of subject object for which the IDs will be returned.

optional_subject_relation: String

optional_subject_relation is the optional relation for the subject.

context: Option<Struct>

context consists of named values that are injected into the caveat evaluation context

optional_concrete_limit: u32

optional_concrete_limit is currently unimplemented for LookupSubjects and will return an error as of SpiceDB version 1.40.1. This will be implemented in a future version of SpiceDB.

optional_cursor: Option<Cursor>

optional_cursor is currently unimplemented for LookupSubjects and will be ignored as of SpiceDB version 1.40.1. This will be implemented in a future version of SpiceDB.

wildcard_option: i32

wildcard_option specifies whether wildcards should be returned by LookupSubjects. For backwards compatibility, defaults to WILDCARD_OPTION_INCLUDE_WILDCARDS if unspecified.

Implementations

impl LookupSubjectsRequest

pub fn wildcard_option(&self) -> WildcardOption

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

pub fn set_wildcard_option(&mut self, value: WildcardOption)

Sets wildcard_option to the provided enum value.

Trait Implementations

impl Clone for LookupSubjectsRequest

fn clone(&self) -> LookupSubjectsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LookupSubjectsRequest

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

Formats the value using the given formatter.

impl Default for LookupSubjectsRequest

fn default() -> LookupSubjectsRequest

Returns the “default value” for a type.

impl Message for LookupSubjectsRequest

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 LookupSubjectsRequest

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