Struct utoipa::openapi::xml::Xml

source ·
#[non_exhaustive]
pub struct Xml { pub name: Option<Cow<'static, str>>, pub namespace: Option<Cow<'static, str>>, pub prefix: Option<Cow<'static, str>>, pub attribute: Option<bool>, pub wrapped: Option<bool>, }
Expand description

Implements OpenAPI Xml Object.

Can be used to modify xml output format of specific OpenAPI Schema Object which are implemented in schema module.

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.
§name: Option<Cow<'static, str>>

Used to replace the name of attribute or type used in schema property. When used with Xml::wrapped attribute the name will be used as a wrapper name for wrapped array instead of the item or type name.

§namespace: Option<Cow<'static, str>>

Valid uri definition of namespace used in xml.

§prefix: Option<Cow<'static, str>>

Prefix for xml element Xml::name.

§attribute: Option<bool>

Flag deciding will this attribute translate to element attribute instead of xml element.

§wrapped: Option<bool>

Flag only usable with array definition. If set to true the output xml will wrap the array of items <pets><pet></pet></pets> instead of unwrapped <pet></pet>.

Implementations§

source§

impl Xml

source

pub fn new() -> Self

Construct a new Xml object.

Trait Implementations§

source§

impl Clone for Xml

source§

fn clone(&self) -> Xml

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 Xml

source§

fn default() -> Xml

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

impl<'de> Deserialize<'de> for Xml

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<Xml> for XmlBuilder

source§

fn from(value: Xml) -> Self

Converts to this type from the input type.
source§

impl From<XmlBuilder> for Xml

source§

fn from(value: XmlBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Xml> for Xml

source§

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

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 Xml

source§

impl StructuralEq for Xml

source§

impl StructuralPartialEq for Xml

Auto Trait Implementations§

§

impl RefUnwindSafe for Xml

§

impl Send for Xml

§

impl Sync for Xml

§

impl Unpin for Xml

§

impl UnwindSafe for Xml

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