Struct HttpBuilder

Source
pub struct HttpBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> HttpBuilder<S>

Source

pub fn build(self) -> Http
where S: IsComplete,

Finish building and return the requested object

Source

pub fn scheme( self, value: impl Into<HttpAuthScheme>, ) -> HttpBuilder<SetScheme<S>>
where S::Scheme: IsUnset,

Required.

Http authorization scheme in HTTP Authorization header value.

Source

pub fn bearer_format( self, value: impl Into<String>, ) -> HttpBuilder<SetBearerFormat<S>>
where S::BearerFormat: IsUnset,

Optional (Some / Option setters).

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

Source

pub fn maybe_bearer_format( self, value: Option<impl Into<String>>, ) -> HttpBuilder<SetBearerFormat<S>>
where S::BearerFormat: IsUnset,

Optional (Some / Option setters).

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

Source

pub fn description( self, value: impl Into<String>, ) -> HttpBuilder<SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters).

Optional description of Http SecurityScheme supporting markdown syntax.

Source

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> HttpBuilder<SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters).

Optional description of Http SecurityScheme supporting markdown syntax.

Source

pub fn extensions( self, value: impl Into<Extensions>, ) -> HttpBuilder<SetExtensions<S>>
where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

Source

pub fn maybe_extensions( self, value: Option<impl Into<Extensions>>, ) -> HttpBuilder<SetExtensions<S>>
where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

Auto Trait Implementations§

§

impl<S> Freeze for HttpBuilder<S>

§

impl<S> RefUnwindSafe for HttpBuilder<S>

§

impl<S> Send for HttpBuilder<S>

§

impl<S> Sync for HttpBuilder<S>

§

impl<S> Unpin for HttpBuilder<S>

§

impl<S> UnwindSafe for HttpBuilder<S>

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>,

Source§

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>,

Source§

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.