Struct AuthorQueryParams

pub struct AuthorQueryParams {
    pub name: Option<String>,
    pub surname: Option<String>,
    pub email: Option<String>,
}

Object that includes the allowed tokens for a search of the /author resource.

Description

All the members are optional, which means clients are free to choose what token to use for a search. The current search logic of the /author collection resource allows only to use a single token per search. This means that if multiple tokens are given, the one with the highest priority will be used. The email hash the highest priority, followed by name and surname.

Fields

name: Option<String>

surname: Option<String>

email: Option<String>

Implementations

impl AuthorQueryParams

pub fn search_token(&self) -> Result<(&str, &str), DataDomainError>

Returns the token that hash the highest priority in a search.

Description

AuthorQueryParams includes all the accepted tokens when a client requests a search of an author entry in the DB. All the tokens are marked as optional, to allow clients use the token they prefer. The current search logic only allows a single token search, which means that if multiple tokens are provided within the same request, only one will be considered.

The email hash the highest priority, followed by name and surname. This method inspects what tokens where provided to the struct, and returns the one that hash the highest priority. If no token was provided, an error is returned instead.

Trait Implementations

impl Debug for AuthorQueryParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthorQueryParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for AuthorQueryParams

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of [openapi::path::Parameter]s to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.