Struct GeneratorFlags 

pub struct GeneratorFlags(/* private fields */);

Different flags that control what code the Generator is generating.

Implementations

impl GeneratorFlags

pub const NONE: Self

None of the features are enabled.

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="MyChoice" mixed="true">
       <xs:choice>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:choice>
   </xs:complexType>

   <xs:complexType name="MySequence" mixed="true">
       <xs:sequence>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:sequence>
   </xs:complexType>
</xs:schema>

Setting none of the flags will result in the following code:

#[derive(Debug)]
pub struct MyChoiceType {
   pub content: MyChoiceTypeContent,
}
#[derive(Debug)]
pub enum MyChoiceTypeContent {
   Once(i32),
   Optional(Option<i32>),
   OnceSpecify(i32),
   TwiceOrMore(Vec<i32>),
}
#[derive(Debug)]
pub struct MySequenceType {
   pub content: MySequenceTypeContent,
}
#[derive(Debug)]
pub struct MySequenceTypeContent {
   pub once: i32,
   pub optional: Option<i32>,
   pub once_specify: i32,
   pub twice_or_more: Vec<i32>,
}

pub const USE_MODULES: Self

The generated code uses modules for the different namespaces.

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="MyChoice" mixed="true">
       <xs:choice>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:choice>
   </xs:complexType>

   <xs:complexType name="MySequence" mixed="true">
       <xs:sequence>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:sequence>
   </xs:complexType>
</xs:schema>

Enable the USE_MODULES feature only will result in the following code:

pub mod tns {
   #[derive(Debug)]
   pub struct MyChoiceType {
       pub content: MyChoiceTypeContent,
   }
   #[derive(Debug)]
   pub enum MyChoiceTypeContent {
       Once(i32),
       Optional(Option<i32>),
       OnceSpecify(i32),
       TwiceOrMore(Vec<i32>),
   }
   #[derive(Debug)]
   pub struct MySequenceType {
       pub content: MySequenceTypeContent,
   }
   #[derive(Debug)]
   pub struct MySequenceTypeContent {
       pub once: i32,
       pub optional: Option<i32>,
       pub once_specify: i32,
       pub twice_or_more: Vec<i32>,
   }
}

pub const USE_NAMESPACE_MODULES: Self

The generated code uses modules for the different namespaces.

See USE_MODULES for details.

pub const USE_SCHEMA_MODULES: Self

The generated code uses modules for the different schemas.

See USE_MODULES for details.

pub const FLATTEN_CONTENT: Self

The generator flattens the content type of choice types if it does not define any element attributes.

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="MyChoice" mixed="true">
       <xs:choice>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:choice>
   </xs:complexType>

   <xs:complexType name="MySequence" mixed="true">
       <xs:sequence>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:sequence>
   </xs:complexType>
</xs:schema>

Enable the FLATTEN_CONTENT feature only will result in the following code:

#[derive(Debug)]
pub enum MyChoiceType {
   Once(i32),
   Optional(Option<i32>),
   OnceSpecify(i32),
   TwiceOrMore(Vec<i32>),
}
#[derive(Debug)]
pub struct MySequenceType {
   pub once: i32,
   pub optional: Option<i32>,
   pub once_specify: i32,
   pub twice_or_more: Vec<i32>,
}

pub const FLATTEN_ENUM_CONTENT: Self

The generator flattens the content of enum types if possible.

See FLATTEN_CONTENT for details.

pub const FLATTEN_STRUCT_CONTENT: Self

The generator flattens the content of struct types if possible.

See FLATTEN_CONTENT for details.

pub const MIXED_TYPE_SUPPORT: Self

Enable support for mixed types.

This will enable code generation for mixed types. This feature needs to be used with caution, because support for mixed types when using serde is quite limited.

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="MyChoice" mixed="true">
       <xs:choice>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:choice>
   </xs:complexType>

   <xs:complexType name="MySequence" mixed="true">
       <xs:sequence>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:sequence>
   </xs:complexType>
</xs:schema>

Enable the BUILD_IN_ABSOLUTE_PATHS feature only will result in the following code:

use xsd_parser::xml::{Mixed, Text};
#[derive(Debug)]
pub struct MyChoiceType {
   pub text_before: Option<Text>,
   pub content: MyChoiceTypeContent,
}
#[derive(Debug)]
pub enum MyChoiceTypeContent {
   Once(Mixed<i32>),
   Optional(Option<Mixed<i32>>),
   OnceSpecify(Mixed<i32>),
   TwiceOrMore(Vec<Mixed<i32>>),
}
#[derive(Debug)]
pub struct MySequenceType {
   pub text_before: Option<Text>,
   pub content: MySequenceTypeContent,
}
#[derive(Debug)]
pub struct MySequenceTypeContent {
   pub once: Mixed<i32>,
   pub optional: Option<Mixed<i32>>,
   pub once_specify: Mixed<i32>,
   pub twice_or_more: Vec<Mixed<i32>>,
}

pub const BUILD_IN_ABSOLUTE_PATHS: Self

Use absolute paths for build in types.

Using this flag will instruct the generator to use absolute paths for build in types (e.g. usize or String) to avoid naming conflicts with generated 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:complexType name="MyChoice" mixed="true">
       <xs:choice>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:choice>
   </xs:complexType>

   <xs:complexType name="MySequence" mixed="true">
       <xs:sequence>
           <xs:element name="Once" type="xs:int" />
           <xs:element name="Optional" type="xs:int" minOccurs="0" />
           <xs:element name="OnceSpecify" type="xs:int" minOccurs="1" />
           <xs:element name="TwiceOrMore" type="xs:int" minOccurs="2" maxOccurs="unbounded" />
       </xs:sequence>
   </xs:complexType>
</xs:schema>

Enable the BUILD_IN_ABSOLUTE_PATHS feature only will result in the following code:

#[derive(Debug)]
pub struct MyChoiceType {
   pub content: MyChoiceTypeContent,
}
#[derive(Debug)]
pub enum MyChoiceTypeContent {
   Once(::core::primitive::i32),
   Optional(Option<::core::primitive::i32>),
   OnceSpecify(::core::primitive::i32),
   TwiceOrMore(Vec<::core::primitive::i32>),
}
#[derive(Debug)]
pub struct MySequenceType {
   pub content: MySequenceTypeContent,
}
#[derive(Debug)]
pub struct MySequenceTypeContent {
   pub once: ::core::primitive::i32,
   pub optional: Option<::core::primitive::i32>,
   pub once_specify: ::core::primitive::i32,
   pub twice_or_more: Vec<::core::primitive::i32>,
}

impl GeneratorFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl GeneratorFlags

pub const fn iter(&self) -> Iter<GeneratorFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<GeneratorFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for GeneratorFlags

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

Formats the value using the given formatter.

impl BitAnd for GeneratorFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = GeneratorFlags

The resulting type after applying the & operator.

impl BitAndAssign for GeneratorFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for GeneratorFlags

fn bitor(self, other: GeneratorFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = GeneratorFlags

The resulting type after applying the | operator.

impl BitOrAssign for GeneratorFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for GeneratorFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = GeneratorFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for GeneratorFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for GeneratorFlags

fn clone(&self) -> GeneratorFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorFlags

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

Formats the value using the given formatter.

impl Extend<GeneratorFlags> for GeneratorFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for GeneratorFlags

const FLAGS: &'static [Flag<GeneratorFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> GeneratorFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<GeneratorFlags> for GeneratorFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for GeneratorFlags

type Item = GeneratorFlags

The type of the elements being iterated over.

type IntoIter = Iter<GeneratorFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for GeneratorFlags

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

Formats the value using the given formatter.

impl Not for GeneratorFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = GeneratorFlags

The resulting type after applying the ! operator.

impl Octal for GeneratorFlags

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

Formats the value using the given formatter.

impl PublicFlags for GeneratorFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for GeneratorFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = GeneratorFlags

The resulting type after applying the - operator.

impl SubAssign for GeneratorFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for GeneratorFlags

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

Formats the value using the given formatter.

impl Copy for GeneratorFlags