Struct utoipa::openapi::security::Http

#[non_exhaustive]
pub struct Http {
    pub scheme: HttpAuthScheme,
    pub bearer_format: Option<String>,
    pub description: Option<String>,
}

Http authentication SecurityScheme builder.

Methods can be chained to configure bearer_format or to add description.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scheme: HttpAuthScheme

Http authorization scheme in HTTP Authorization header value.

bearer_format: Option<String>

Optional hint to client how the bearer token is formatted. Valid only with HttpAuthScheme::Bearer.

description: Option<String>

Optional description of Http SecurityScheme supporting markdown syntax.

Implementations

impl Http

pub fn new(scheme: HttpAuthScheme) -> Self

Create new http authentication security schema.

Accepts one argument which defines the scheme of the http authentication.

Examples

Create http security schema with basic authentication.

SecurityScheme::Http(Http::new(HttpAuthScheme::Basic));

Trait Implementations

impl Clone for Http

fn clone(&self) -> Http

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Http

fn default() -> Http

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Http

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Http> for HttpBuilder

fn from(value: Http) -> Self

Converts to this type from the input type.

impl From<HttpBuilder> for Http

fn from(value: HttpBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Http

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Http

impl StructuralPartialEq for Http