Enum SerdeSupport

Source
pub enum SerdeSupport {
    None,
    QuickXml,
    SerdeXmlRs,
}
Expand description

Tells the Generator how to generate code for the serde crate.

Variants§

§

None

No code for the serde crate is generated.

§Examples

Consider the following XML schema:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:tns="http://example.com"
    targetNamespace="http://example.com">

    <xs:complexType name="MyAll">
        <xs:all>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:all>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MyChoice">
        <xs:choice>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:choice>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MySequence">
        <xs:sequence>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:sequence>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>
</xs:schema>

If the serde support mode is set to SerdeSupport::None the following code is rendered:

#[derive(Debug, Clone)]
pub struct MyAllType {
    pub x: Option<bool>,
    pub a: i32,
    pub b: String,
}
#[derive(Debug, Clone)]
pub struct MyChoiceType {
    pub x: Option<bool>,
    pub content: MyChoiceTypeContent,
}
#[derive(Debug, Clone)]
pub enum MyChoiceTypeContent {
    A(i32),
    B(String),
}
#[derive(Debug, Clone)]
pub struct MySequenceType {
    pub x: Option<bool>,
    pub a: i32,
    pub b: String,
}
§

QuickXml

Generates code that can be serialized and deserialized using the serde create in combination with the with quick_xml crate.

§Examples

Consider the following XML schema:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:tns="http://example.com"
    targetNamespace="http://example.com">

    <xs:complexType name="MyAll">
        <xs:all>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:all>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MyChoice">
        <xs:choice>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:choice>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MySequence">
        <xs:sequence>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:sequence>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>
</xs:schema>

If the serde support mode is set to SerdeSupport::QuickXml the following code is rendered:

use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MyAllType {
    #[serde(default, rename = "@x")]
    pub x: Option<bool>,
    #[serde(rename = "a")]
    pub a: i32,
    #[serde(rename = "b")]
    pub b: String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MyChoiceType {
    #[serde(default, rename = "@x")]
    pub x: Option<bool>,
    #[serde(rename = "$value")]
    pub content: MyChoiceTypeContent,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MyChoiceTypeContent {
    #[serde(rename = "a")]
    A(i32),
    #[serde(rename = "b")]
    B(String),
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MySequenceType {
    #[serde(default, rename = "@x")]
    pub x: Option<bool>,
    #[serde(rename = "a")]
    pub a: i32,
    #[serde(rename = "b")]
    pub b: String,
}
§

SerdeXmlRs

Generates code that can be serialized and deserialized using the serde create in combination with the with serde-xml-rs crate.

§Examples

Consider the following XML schema:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:tns="http://example.com"
    targetNamespace="http://example.com">

    <xs:complexType name="MyAll">
        <xs:all>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:all>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MyChoice">
        <xs:choice>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:choice>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>

    <xs:complexType name="MySequence">
        <xs:sequence>
            <xs:element name="a" type="xs:int" />
            <xs:element name="b" type="xs:string" />
        </xs:sequence>
        <xs:attribute name="x" type="xs:boolean" />
    </xs:complexType>
</xs:schema>

If the serde support mode is set to SerdeSupport::SerdeXmlRs the following code is rendered:

use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MyAllType {
    #[serde(default, rename = "x")]
    pub x: Option<bool>,
    #[serde(rename = "a")]
    pub a: i32,
    #[serde(rename = "b")]
    pub b: String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MyChoiceType {
    #[serde(default, rename = "x")]
    pub x: Option<bool>,
    #[serde(rename = "$value")]
    pub content: MyChoiceTypeContent,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MyChoiceTypeContent {
    #[serde(rename = "a")]
    A(i32),
    #[serde(rename = "b")]
    B(String),
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MySequenceType {
    #[serde(default, rename = "x")]
    pub x: Option<bool>,
    #[serde(rename = "a")]
    pub a: i32,
    #[serde(rename = "b")]
    pub b: String,
}

Implementations§

Source§

impl SerdeSupport

Source

pub fn is_none(&self) -> bool

Returns true if this is equal to SerdeSupport::None, false otherwise.

Source

pub fn is_some(&self) -> bool

Returns false if this is equal to SerdeSupport::None, true otherwise.

Trait Implementations§

Source§

impl Clone for SerdeSupport

Source§

fn clone(&self) -> SerdeSupport

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 Debug for SerdeSupport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SerdeSupport

Source§

fn default() -> SerdeSupport

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

impl PartialEq for SerdeSupport

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for SerdeSupport

Source§

impl Eq for SerdeSupport

Source§

impl StructuralPartialEq for SerdeSupport

Auto Trait Implementations§

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<X> AsAny for X
where X: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Get a reference to the current object as Any.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Get a mutable reference to the current object as Any.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

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 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T