Enum rbx_xml::DecodePropertyBehavior

#[non_exhaustive]
pub enum DecodePropertyBehavior {
    IgnoreUnknown,
    ReadUnknown,
    ErrorOnUnknown,
    NoReflection,
}

Describes the strategy that rbx_xml should use when deserializing properties.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

IgnoreUnknown

Ignores properties that aren’t known by rbx_xml.

The default and safest option. With this set, properties that are newer than the reflection database rbx_xml uses won’t show up when deserializing files.

ReadUnknown

Read properties that aren’t known by rbx_xml.

With this option set, properties that are newer than rbx_xml’s reflection database will show up. It may be problematic to depend on these properties, since rbx_xml may start supporting them with non-reflection specific names at a future date.

ErrorOnUnknown

Returns an error if any properties are found that aren’t known by rbx_xml.

NoReflection

Completely turns off rbx_xml’s reflection database. Property names and types will appear exactly as they are in XML.

This setting is useful for debugging the model format. It leaves the user to deal with oddities like how Part.FormFactor is actually serialized as Part.formFactorRaw.

Trait Implementations

impl Clone for DecodePropertyBehavior

fn clone(&self) -> DecodePropertyBehavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecodePropertyBehavior

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

Formats the value using the given formatter.

impl Hash for DecodePropertyBehavior

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DecodePropertyBehavior

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

impl Eq for DecodePropertyBehavior

impl StructuralEq for DecodePropertyBehavior

impl StructuralPartialEq for DecodePropertyBehavior