Struct KeyOn 

pub struct KeyOn {
    pub path_params: Option<SmallVec<[String; 2]>>,
    pub query_keys: Option<SmallVec<[String; 2]>>,
    pub body_hash: Option<bool>,
    pub etag: Option<bool>,
}

Fields

path_params: Option<SmallVec<[String; 2]>>

which params from the path to key on.

i.e /some/path/{key_on_me} OR /some/path/{*key_on_me} would use { "path_params": ["key_on_me"] }

query_keys: Option<SmallVec<[String; 2]>>

which keys from the query to key on.

i.e ?some=123 { "query_keys": ["some"] }

body_hash: Option<bool>

whether to key on a hash of the incoming request body.

etag: Option<bool>

whether to check/store the ETag before everything else.

defaults to true if not passed.

Trait Implementations

impl Clone for KeyOn

fn clone(&self) -> KeyOn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for KeyOn

Available on crate feature utoipa only.

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

impl Debug for KeyOn

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyOn

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KeyOn

Available on crate feature docs only.

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for KeyOn

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for KeyOn

Available on crate feature utoipa only.

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.