Struct LoadKeysetRequest 

pub struct LoadKeysetRequest {
    pub client_id: Uuid,
    pub keyset_id: Option<IdentifiedBy>,
}

Request to load a keyset on behalf of a client. This is used by clients before indexing or querying data and includes key material which can be derived by the client to generate encrypted index terms.

If a keyset_id is not provided the client’s default keyset will be loaded.

Requires the data_key:retrieve scope (though this may change in the future). Response is a LoadKeysetResponse.

Fields

client_id: Uuid

keyset_id: Option<IdentifiedBy>

The keyset to load. Accepts a UUID or a name string. If omitted, the client’s default keyset is used.

Trait Implementations

impl ComposeSchema for LoadKeysetRequest

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for LoadKeysetRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoadKeysetRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LoadKeysetRequest

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

fn partial_cmp(&self, other: &LoadKeysetRequest) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LoadKeysetRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoadKeysetRequest

impl ToSchema for LoadKeysetRequest

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl ViturRequest for LoadKeysetRequest

const ENDPOINT: &'static str = "load-keyset"

const SCOPE: Scope

type Response = LoadKeysetResponse