Struct salvo_oapi::Xml

#[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>,
}

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)

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

impl Xml

pub fn new() -> Self

Construct a new Xml object.

impl Xml

pub fn name<S: Into<Cow<'static, str>>>(self, name: S) -> Self

Add Xml::name to xml object.

Builder style chainable consuming add name method.

pub fn namespace<S: Into<Cow<'static, str>>>(self, namespace: S) -> Self

Add Xml::namespace to xml object.

Builder style chainable consuming add namespace method.

pub fn prefix<S: Into<Cow<'static, str>>>(self, prefix: S) -> Self

Add Xml::prefix to xml object.

Builder style chainable consuming add prefix method.

pub fn attribute(self, attribute: bool) -> Self

Mark Xml object as attribute. See Xml::attribute

Builder style chainable consuming add attribute method.

pub fn wrapped(self, wrapped: bool) -> Self

Mark Xml object wrapped. See Xml::wrapped

Builder style chainable consuming add wrapped method.

Trait Implementations

impl Clone for Xml

fn clone(&self) -> Xml

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Xml

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Xml

fn default() -> Xml

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Xml

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

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

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.

impl Serialize for Xml

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 Xml

impl StructuralPartialEq for Xml