TypedefMode

Enum TypedefMode 

Source
pub enum TypedefMode {
    Auto,
    Typedef,
    NewType,
}
Expand description

Tells the Generator how to deal with type definitions.

Variants§

§

Auto

The Generator will automatically detect if a new type struct or a simple type definition should be used for a Reference type.

Detecting the correct type automatically depends basically on the occurrence of the references type. If the target type is only referenced exactly once, a type definition is rendered. If a different occurrence is used, it is wrapped in a new type struct because usually additional code needs to be implemented for such types.

§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:simpleType name="MyList">
        <xs:list itemType="xs:int" />
    </xs:simpleType>

    <xs:simpleType name="MyType">
        <xs:restriction base="xs:int" />
    </xs:simpleType>
</xs:schema>

If the typedef mode is set to TypedefMode::Auto the following code is rendered:

pub type MyType = i32;
#[derive(Debug, Default)]
pub struct MyListType(pub Vec<IntType>);
pub type IntType = i32;
§

Typedef

The Generator will always use a simple type definition for a Reference type.

§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:simpleType name="MyList">
        <xs:list itemType="xs:int" />
    </xs:simpleType>

    <xs:simpleType name="MyType">
        <xs:restriction base="xs:int" />
    </xs:simpleType>
</xs:schema>

If the typedef mode is set to TypedefMode::Typedef the following code is rendered:

pub type MyType = i32;
pub type MyListType = Vec<IntType>;
pub type IntType = i32;
§

NewType

The Generator will always use a new type struct for a Reference type.

§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:simpleType name="MyList">
        <xs:list itemType="xs:int" />
    </xs:simpleType>

    <xs:simpleType name="MyType">
        <xs:restriction base="xs:int" />
    </xs:simpleType>
</xs:schema>

If the typedef mode is set to TypedefMode::NewType the following code is rendered:

#[derive(Debug)]
pub struct MyType(pub i32);
#[derive(Debug, Default)]
pub struct MyListType(pub Vec<IntType>);
#[derive(Debug)]
pub struct IntType(pub i32);

Trait Implementations§

Source§

impl Clone for TypedefMode

Source§

fn clone(&self) -> TypedefMode

Returns a duplicate 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 TypedefMode

Source§

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

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

impl Default for TypedefMode

Source§

fn default() -> TypedefMode

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

impl PartialEq for TypedefMode

Source§

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

Source§

impl Eq for TypedefMode

Source§

impl StructuralPartialEq for TypedefMode

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where 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> 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,