Struct utoipa::openapi::info::Info

source ·
#[non_exhaustive]
pub struct Info { pub title: String, pub description: Option<String>, pub terms_of_service: Option<String>, pub contact: Option<Contact>, pub license: Option<License>, pub version: String, }
Expand description

OpenAPI Info object represents metadata of the API.

You can use Info::new to construct a new Info object or alternatively use InfoBuilder::new to construct a new Info with chainable configuration methods.

Fields (Non-exhaustive)§

This struct is marked as 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.
§title: String

Title of the API.

§description: Option<String>

Optional description of the API.

Value supports markdown syntax.

§terms_of_service: Option<String>

Optional url for terms of service.

§contact: Option<Contact>

Contact information of exposed API.

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

§license: Option<License>

License of the API.

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

§version: String

Document version typically the API version.

Implementations§

source§

impl Info

source

pub fn new<S: Into<String>>(title: S, version: S) -> Self

Construct a new Info object.

This function accepts two arguments. One which is the title of the API and two the version of the api document typically the API version.

Examples
let info = Info::new("Pet api", "1.1.0");

Trait Implementations§

source§

impl Clone for Info

source§

fn clone(&self) -> Info

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Info

source§

fn default() -> Info

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

impl<'de> Deserialize<'de> for Info

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Info> for InfoBuilder

source§

fn from(value: Info) -> Self

Converts to this type from the input type.
source§

impl From<InfoBuilder> for Info

source§

fn from(value: InfoBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Info> for Info

source§

fn eq(&self, other: &Info) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Info

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Info

source§

impl StructuralEq for Info

source§

impl StructuralPartialEq for Info

Auto Trait Implementations§

§

impl RefUnwindSafe for Info

§

impl Send for Info

§

impl Sync for Info

§

impl Unpin for Info

§

impl UnwindSafe for Info

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,