Struct utoipa::openapi::security::HttpBuilder

source ·
pub struct HttpBuilder { /* private fields */ }
Expand description

Builder for Http with chainable configuration methods to create a new Http.

Implementations§

source§

impl HttpBuilder

source

pub fn new() -> HttpBuilder

Constructs a new HttpBuilder.

source

pub fn build(self) -> Http

Constructs a new Http taking all fields values from this object.

source§

impl HttpBuilder

source

pub fn scheme(self, scheme: HttpAuthScheme) -> Self

Add or change http authentication scheme used.

§Examples

Create new Http SecurityScheme via HttpBuilder.

let http = HttpBuilder::new().scheme(HttpAuthScheme::Basic).build();
source

pub fn bearer_format<S: Into<String>>(self, bearer_format: S) -> Self

Add or change informative bearer format for http security schema.

This is only applicable to HttpAuthScheme::Bearer.

§Examples

Add JTW bearer format for security schema.

HttpBuilder::new().scheme(HttpAuthScheme::Bearer).bearer_format("JWT").build();
source

pub fn description<S: Into<String>>(self, description: Option<S>) -> Self

Add or change optional description supporting markdown syntax.

Trait Implementations§

source§

impl Default for HttpBuilder

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<Http> for HttpBuilder

source§

fn from(value: Http) -> Self

Converts to this type from the input type.
source§

impl From<HttpBuilder> for Http

source§

fn from(value: HttpBuilder) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.