Struct utoipa::openapi::info::Contact

#[non_exhaustive]
pub struct Contact {
    pub name: Option<String>,
    pub url: Option<String>,
    pub email: Option<String>,
}

OpenAPI Contact information of the API.

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

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.

name: Option<String>

Identifying name of the contact person or organization of the API.

url: Option<String>

Url pointing to contact information of the API.

email: Option<String>

Email of the contact person or the organization of the API.

Implementations

impl Contact

pub fn new() -> Self

Construct a new Contact.

Trait Implementations

impl Clone for Contact

fn clone(&self) -> Contact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Contact

fn default() -> Contact

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Contact

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Contact> for ContactBuilder

fn from(value: Contact) -> Self

Converts to this type from the input type.

impl From<ContactBuilder> for Contact

fn from(value: ContactBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Contact

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

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 Contact

impl StructuralPartialEq for Contact