Struct schema_analysis::FieldStatus

pub struct FieldStatus {
    pub may_be_null: bool,
    pub may_be_normal: bool,
    pub may_be_missing: bool,
    pub may_be_duplicate: bool,
}

The FieldStatus keeps track of what kind of values a Field has been found to have.

Fields

may_be_null: bool

The Field has been found to be None or of the unit type ().

may_be_normal: bool

The Field has been found to be a normal value, where normal means any valid value for the Schema associated with the Field.

may_be_missing: bool

The Field was found only on some Structs or the Sequence to which it belongs might be empty (if only empty sequences are found, then the Schema in the Field will also be None).

may_be_duplicate: bool

Sometimes a field might appear more than once in the same Struct. In that case all instances are considered, but this flag is also enabled. This is useful to spot suspicious data, but also to detect sequences in xml files. See here for more info.

Implementations

impl FieldStatus

pub fn allow_duplicates(&mut self, is_duplicate: bool)

If the value passed is true, then the status will allow duplicates. Otherwise no changes are made.

pub fn is_option(&self) -> bool

true if the status allows for null or missing values.

Trait Implementations

impl Clone for FieldStatus

fn clone(&self) -> FieldStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Coalesce for FieldStatus

fn coalesce(&mut self, other: Self)where
    Self: Sized,

Merge other into self.

impl Debug for FieldStatus

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

Formats the value using the given formatter.

impl Default for FieldStatus

fn default() -> FieldStatus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FieldStatus

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<FieldStatus> for FieldStatus

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

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 FieldStatus

impl StructuralEq for FieldStatus

impl StructuralPartialEq for FieldStatus