openapiv3_1::info

Struct InfoBuilder

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

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

Implementations§

Source§

impl<S: State> InfoBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn title(self, value: impl Into<String>) -> InfoBuilder<SetTitle<S>>
where S::Title: IsUnset,

Required.

Title of the API.

Source

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

Optional (Some / Option setters).

Optional description of the API.

Value supports markdown syntax.

Source

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

Optional (Some / Option setters).

Optional description of the API.

Value supports markdown syntax.

Source

pub fn terms_of_service( self, value: impl Into<String>, ) -> InfoBuilder<SetTermsOfService<S>>
where S::TermsOfService: IsUnset,

Optional (Some / Option setters).

Optional url for terms of service.

Source

pub fn maybe_terms_of_service( self, value: Option<impl Into<String>>, ) -> InfoBuilder<SetTermsOfService<S>>
where S::TermsOfService: IsUnset,

Optional (Some / Option setters).

Optional url for terms of service.

Source

pub fn contact(self, value: impl Into<Contact>) -> InfoBuilder<SetContact<S>>
where S::Contact: IsUnset,

Optional (Some / Option setters).

Contact information of exposed API.

See more details at: https://spec.openapis.org/oas/latest.html#contact-object.

Source

pub fn maybe_contact( self, value: Option<impl Into<Contact>>, ) -> InfoBuilder<SetContact<S>>
where S::Contact: IsUnset,

Optional (Some / Option setters).

Contact information of exposed API.

See more details at: https://spec.openapis.org/oas/latest.html#contact-object.

Source

pub fn license(self, value: impl Into<License>) -> InfoBuilder<SetLicense<S>>
where S::License: IsUnset,

Optional (Some / Option setters).

License of the API.

See more details at: https://spec.openapis.org/oas/latest.html#license-object.

Source

pub fn maybe_license( self, value: Option<impl Into<License>>, ) -> InfoBuilder<SetLicense<S>>
where S::License: IsUnset,

Optional (Some / Option setters).

License of the API.

See more details at: https://spec.openapis.org/oas/latest.html#license-object.

Source

pub fn version(self, value: impl Into<String>) -> InfoBuilder<SetVersion<S>>
where S::Version: IsUnset,

Required.

Document version typically the API version.

Source

pub fn extensions( self, value: impl Into<Extensions>, ) -> InfoBuilder<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>>, ) -> InfoBuilder<SetExtensions<S>>
where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

Trait Implementations§

Source§

impl<S: IsComplete> From<InfoBuilder<S>> for Info

Source§

fn from(builder: InfoBuilder<S>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<S> Freeze for InfoBuilder<S>

§

impl<S> RefUnwindSafe for InfoBuilder<S>

§

impl<S> Send for InfoBuilder<S>

§

impl<S> Sync for InfoBuilder<S>

§

impl<S> Unpin for InfoBuilder<S>

§

impl<S> UnwindSafe for InfoBuilder<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.