ion_schema/

constraint.rs

use crate::ion_extension::ElementExtensions;
use crate::ion_path::{IonPath, IonPathElement};
use crate::isl::isl_constraint::{
    IslAnnotationsConstraint, IslConstraintValue, IslRegexConstraint,
};
use crate::isl::isl_type_reference::{
    IslTypeRef, IslVariablyOccurringTypeRef, NullabilityModifier,
};
use crate::isl::ranges::{I64Range, Limit, TimestampPrecisionRange, U64Range, UsizeRange};
use crate::isl::util::{
    Annotation, Ieee754InterchangeFormat, TimestampOffset, TimestampPrecision, ValidValue,
};
use crate::isl::IslVersion;
use crate::isl_require;
use crate::ordered_elements_nfa::OrderedElementsNfa;
use crate::result::{
    invalid_schema_error, invalid_schema_error_raw, IonSchemaResult, ValidationResult,
};
use crate::system::{PendingTypes, TypeId, TypeStore};
use crate::type_reference::{TypeReference, VariablyOccurringTypeRef};
use crate::types::TypeValidator;
use crate::violation::{Violation, ViolationCode};
use crate::IonSchemaElement;
use ion_rs::Element;
use ion_rs::IonData;
use ion_rs::IonType;
use ion_rs::Value;
use num_traits::ToPrimitive;
use regex::{Regex, RegexBuilder};
use std::collections::{HashMap, HashSet};
use std::fmt::{Display, Formatter};
use std::iter::Peekable;
use std::ops::Neg;
use std::str::Chars;

/// Provides validation for schema Constraint
pub trait ConstraintValidator {
    /// Checks this constraint against the provided value,
    /// adding [Violation]s and/or [ViolationChild]ren to `Err(violation)`
    /// if the constraint is violated.
    /// Otherwise, if the value passes the validation against the constraint then returns `Ok(())`.
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult;
}

/// Defines schema Constraints
#[derive(Debug, Clone, PartialEq)]
// TODO: add other constraints
pub enum Constraint {
    AllOf(AllOfConstraint),
    Annotations(AnnotationsConstraint),
    Annotations2_0(AnnotationsConstraint2_0),
    AnyOf(AnyOfConstraint),
    ByteLength(ByteLengthConstraint),
    CodepointLength(CodepointLengthConstraint),
    Contains(ContainsConstraint),
    ContentClosed,
    ContainerLength(ContainerLengthConstraint),
    Element(ElementConstraint),
    Exponent(ExponentConstraint),
    FieldNames(FieldNamesConstraint),
    Fields(FieldsConstraint),
    Ieee754Float(Ieee754FloatConstraint),
    Not(NotConstraint),
    OneOf(OneOfConstraint),
    OrderedElements(OrderedElementsConstraint),
    Precision(PrecisionConstraint),
    Regex(RegexConstraint),
    Scale(ScaleConstraint),
    TimestampOffset(TimestampOffsetConstraint),
    TimestampPrecision(TimestampPrecisionConstraint),
    Type(TypeConstraint),
    Unknown(String, Element),
    Utf8ByteLength(Utf8ByteLengthConstraint),
    ValidValues(ValidValuesConstraint),
}

impl Constraint {
    /// Creates a [Constraint::Type] referring to the type represented by the provided [TypeId].
    pub fn type_constraint(type_id: TypeId) -> Constraint {
        Constraint::Type(TypeConstraint::new(TypeReference::new(
            type_id,
            NullabilityModifier::Nothing,
        )))
    }

    /// Creates a [Constraint::AllOf] referring to the types represented by the provided [TypeId]s.
    pub fn all_of<A: Into<Vec<TypeId>>>(type_ids: A) -> Constraint {
        let type_references = type_ids
            .into()
            .iter()
            .map(|id| TypeReference::new(*id, NullabilityModifier::Nothing))
            .collect();
        Constraint::AllOf(AllOfConstraint::new(type_references))
    }

    /// Creates a [Constraint::AnyOf] referring to the types represented by the provided [TypeId]s.
    pub fn any_of<A: Into<Vec<TypeId>>>(type_ids: A) -> Constraint {
        let type_references = type_ids
            .into()
            .iter()
            .map(|id| TypeReference::new(*id, NullabilityModifier::Nothing))
            .collect();
        Constraint::AnyOf(AnyOfConstraint::new(type_references))
    }

    /// Creates a [Constraint::OneOf] referring to the types represented by the provided [TypeId]s.
    pub fn one_of<A: Into<Vec<TypeId>>>(type_ids: A) -> Constraint {
        let type_references = type_ids
            .into()
            .iter()
            .map(|id| TypeReference::new(*id, NullabilityModifier::Nothing))
            .collect();
        Constraint::OneOf(OneOfConstraint::new(type_references))
    }

    /// Creates a [Constraint::Not] referring to the type represented by the provided [TypeId].
    pub fn not(type_id: TypeId) -> Constraint {
        Constraint::Not(NotConstraint::new(TypeReference::new(
            type_id,
            NullabilityModifier::Nothing,
        )))
    }

    /// Creates a [Constraint::OrderedElements] referring to the types represented by the provided [TypeId]s.
    pub fn ordered_elements<A: Into<Vec<TypeId>>>(type_ids: A) -> Constraint {
        let type_references = type_ids
            .into()
            .iter()
            .map(|id| {
                VariablyOccurringTypeRef::new(
                    TypeReference::new(*id, NullabilityModifier::Nothing),
                    UsizeRange::new_single_value(1),
                )
            })
            .collect();
        Constraint::OrderedElements(OrderedElementsConstraint::new(type_references))
    }

    /// Creates a [Constraint::Contains] referring to [Elements] specified inside it
    pub fn contains<A: Into<Vec<Element>>>(values: A) -> Constraint {
        Constraint::Contains(ContainsConstraint::new(values.into()))
    }

    /// Creates a [Constraint::ContainerLength] from a [UsizeRange] specifying a length range.
    pub fn container_length(length: UsizeRange) -> Constraint {
        Constraint::ContainerLength(ContainerLengthConstraint::new(length))
    }

    /// Creates a [Constraint::ByteLength] from a [UsizeRange] specifying a length range.
    pub fn byte_length(length: UsizeRange) -> Constraint {
        Constraint::ByteLength(ByteLengthConstraint::new(length))
    }

    /// Creates a [Constraint::CodePointLength] from a [UsizeRange] specifying a length range.
    pub fn codepoint_length(length: UsizeRange) -> Constraint {
        Constraint::CodepointLength(CodepointLengthConstraint::new(length))
    }

    /// Creates a [Constraint::Element] referring to the type represented by the provided [TypeId] and the boolean represents whether distinct elements are required or not.
    pub fn element(type_id: TypeId, requires_distinct: bool) -> Constraint {
        Constraint::Element(ElementConstraint::new(
            TypeReference::new(type_id, NullabilityModifier::Nothing),
            requires_distinct,
        ))
    }

    /// Creates a [Constraint::Annotations] using [str]s and [Element]s specified inside it
    pub fn annotations<'a, A: IntoIterator<Item = &'a str>, B: IntoIterator<Item = Element>>(
        annotations_modifiers: A,
        annotations: B,
    ) -> Constraint {
        let annotations_modifiers: Vec<&str> = annotations_modifiers.into_iter().collect();
        let annotations: Vec<Annotation> = annotations
            .into_iter()
            .map(|a| {
                Annotation::new(
                    a.as_text().unwrap().to_owned(),
                    Annotation::is_annotation_required(
                        &a,
                        annotations_modifiers.contains(&"required"),
                    ),
                    IslVersion::V1_0,
                )
            })
            .collect();
        Constraint::Annotations(AnnotationsConstraint::new(
            annotations_modifiers.contains(&"closed"),
            annotations_modifiers.contains(&"ordered"),
            annotations,
        ))
    }

    /// Creates a [Constraint::Annotations] using [TypeId] specified inside it
    pub fn annotations_v2_0(id: TypeId) -> Constraint {
        Constraint::Annotations2_0(AnnotationsConstraint2_0::new(TypeReference::new(
            id,
            NullabilityModifier::Nothing,
        )))
    }

    /// Creates a [Constraint::Precision] from a [Range] specifying a precision range.
    pub fn precision(precision: U64Range) -> Constraint {
        Constraint::Precision(PrecisionConstraint::new(precision))
    }

    /// Creates a [Constraint::Scale] from a [Range] specifying a precision range.
    pub fn scale(scale: I64Range) -> Constraint {
        Constraint::Scale(ScaleConstraint::new(scale))
    }
    /// Creates a [Constraint::Exponent] from a [Range] specifying an exponent range.
    pub fn exponent(exponent: I64Range) -> Constraint {
        Constraint::Exponent(ExponentConstraint::new(exponent))
    }

    /// Creates a [Constraint::TimestampPrecision] from a [Range] specifying a precision range.
    pub fn timestamp_precision(precision: TimestampPrecisionRange) -> Constraint {
        Constraint::TimestampPrecision(TimestampPrecisionConstraint::new(precision))
    }

    /// Creates an [Constraint::TimestampOffset] using the offset list specified in it
    pub fn timestamp_offset(offsets: Vec<TimestampOffset>) -> Constraint {
        Constraint::TimestampOffset(TimestampOffsetConstraint::new(offsets))
    }

    /// Creates a [Constraint::Utf8ByteLength] from a [Range] specifying a length range.
    pub fn utf8_byte_length(length: UsizeRange) -> Constraint {
        Constraint::Utf8ByteLength(Utf8ByteLengthConstraint::new(length))
    }

    /// Creates a [Constraint::Fields] referring to the fields represented by the provided field name and [TypeId]s.
    /// By default, fields created using this method will allow open content
    pub fn fields<I>(fields: I) -> Constraint
    where
        I: Iterator<Item = (String, TypeId)>,
    {
        let fields = fields
            .map(|(field_name, type_id)| {
                (
                    field_name,
                    VariablyOccurringTypeRef::new(
                        TypeReference::new(type_id, NullabilityModifier::Nothing),
                        UsizeRange::zero_or_one(),
                    ),
                )
            })
            .collect();
        Constraint::Fields(FieldsConstraint::new(fields, true))
    }

    /// Creates a [Constraint::FieldNames] referring to the type represented by the provided [TypeId] and the boolean represents whether each field name should be distinct or not.
    pub fn field_names(type_id: TypeId, requires_distinct: bool) -> Constraint {
        Constraint::FieldNames(FieldNamesConstraint::new(
            TypeReference::new(type_id, NullabilityModifier::Nothing),
            requires_distinct,
        ))
    }

    /// Creates a [Constraint::ValidValues] using the [Element]s specified inside it
    /// Returns an IonSchemaError if any of the Elements have an annotation other than `range`
    pub fn valid_values(
        valid_values: Vec<ValidValue>,
        isl_version: IslVersion,
    ) -> IonSchemaResult<Constraint> {
        Ok(Constraint::ValidValues(ValidValuesConstraint::new(
            valid_values,
            isl_version,
        )?))
    }

    /// Creates a [Constraint::Regex] from the expression and flags (case_insensitive, multi_line) and also specify the ISL version
    pub fn regex(
        case_insensitive: bool,
        multi_line: bool,
        expression: String,
        isl_version: IslVersion,
    ) -> IonSchemaResult<Constraint> {
        let regex = IslRegexConstraint::new(case_insensitive, multi_line, expression);
        Ok(Constraint::Regex(RegexConstraint::from_isl(
            &regex,
            isl_version,
        )?))
    }

    /// Creates a [Constraint::Ieee754Float] from [Ieee754InterchangeFormat] specified inside it
    pub fn ieee754_float(interchange_format: Ieee754InterchangeFormat) -> Constraint {
        Constraint::Ieee754Float(Ieee754FloatConstraint::new(interchange_format))
    }

    /// Resolves all ISL type references to corresponding [TypeReference]s
    fn resolve_type_references(
        isl_version: IslVersion,
        type_references: &[IslTypeRef],
        type_store: &mut TypeStore,
        pending_types: &mut PendingTypes,
    ) -> IonSchemaResult<Vec<TypeReference>> {
        type_references
            .iter()
            .map(|t| IslTypeRef::resolve_type_reference(isl_version, t, type_store, pending_types))
            .collect::<IonSchemaResult<Vec<TypeReference>>>()
    }

    /// Parse an [IslConstraint] to a [Constraint]
    pub(crate) fn resolve_from_isl_constraint(
        isl_version: IslVersion,
        isl_constraint: &IslConstraintValue,
        type_store: &mut TypeStore,
        pending_types: &mut PendingTypes,
        open_content: bool, // this will be used by Fields constraint to verify if open content is allowed or not
    ) -> IonSchemaResult<Constraint> {
        // TODO: add more constraints below
        match isl_constraint {
            IslConstraintValue::AllOf(isl_type_references) => {
                let type_references = Constraint::resolve_type_references(
                    isl_version,
                    isl_type_references,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::AllOf(AllOfConstraint::new(type_references)))
            }
            IslConstraintValue::Annotations(isl_annotations) => match isl_annotations {
                IslAnnotationsConstraint::SimpleAnnotations(simple_annotations) => {
                    match isl_version {
                        IslVersion::V1_0 => {
                            Ok(Constraint::Annotations(AnnotationsConstraint::new(
                                simple_annotations.is_closed,
                                simple_annotations.is_ordered,
                                simple_annotations.annotations.to_owned(),
                            )))
                        }
                        IslVersion::V2_0 => {
                            let type_ref = IslTypeRef::resolve_type_reference(
                                IslVersion::V2_0,
                                &simple_annotations.convert_to_type_reference()?,
                                type_store,
                                pending_types,
                            )?;

                            Ok(Constraint::Annotations2_0(AnnotationsConstraint2_0::new(
                                type_ref,
                            )))
                        }
                    }
                }
                IslAnnotationsConstraint::StandardAnnotations(isl_type_ref) => {
                    let type_ref = IslTypeRef::resolve_type_reference(
                        isl_version,
                        isl_type_ref,
                        type_store,
                        pending_types,
                    )?;
                    Ok(Constraint::Annotations2_0(AnnotationsConstraint2_0::new(
                        type_ref,
                    )))
                }
            },
            IslConstraintValue::AnyOf(isl_type_references) => {
                let type_references = Constraint::resolve_type_references(
                    isl_version,
                    isl_type_references,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::AnyOf(AnyOfConstraint::new(type_references)))
            }
            IslConstraintValue::ByteLength(byte_length) => Ok(Constraint::ByteLength(
                ByteLengthConstraint::new(byte_length.to_owned()),
            )),
            IslConstraintValue::CodepointLength(codepoint_length) => {
                Ok(Constraint::CodepointLength(CodepointLengthConstraint::new(
                    codepoint_length.to_owned(),
                )))
            }
            IslConstraintValue::Contains(values) => {
                let contains_constraint: ContainsConstraint =
                    ContainsConstraint::new(values.to_owned());
                Ok(Constraint::Contains(contains_constraint))
            }
            IslConstraintValue::ContentClosed => Ok(Constraint::ContentClosed),
            IslConstraintValue::ContainerLength(isl_length) => Ok(Constraint::ContainerLength(
                ContainerLengthConstraint::new(isl_length.to_owned()),
            )),
            IslConstraintValue::Element(type_reference, require_distinct_elements) => {
                let type_id = IslTypeRef::resolve_type_reference(
                    isl_version,
                    type_reference,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::Element(ElementConstraint::new(
                    type_id,
                    *require_distinct_elements,
                )))
            }
            IslConstraintValue::FieldNames(isl_type_reference, distinct) => {
                let type_reference = IslTypeRef::resolve_type_reference(
                    isl_version,
                    isl_type_reference,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::FieldNames(FieldNamesConstraint::new(
                    type_reference,
                    *distinct,
                )))
            }
            IslConstraintValue::Fields(fields, content_closed) => {
                let open_content = match isl_version {
                    IslVersion::V1_0 => open_content,
                    IslVersion::V2_0 => !content_closed, // for ISL 2.0 whether open content is allowed or not depends on `fields` constraint
                };
                let fields_constraint: FieldsConstraint =
                    FieldsConstraint::resolve_from_isl_constraint(
                        isl_version,
                        fields,
                        type_store,
                        pending_types,
                        open_content,
                    )?;
                Ok(Constraint::Fields(fields_constraint))
            }
            IslConstraintValue::Ieee754Float(iee754_interchange_format) => Ok(
                Constraint::Ieee754Float(Ieee754FloatConstraint::new(*iee754_interchange_format)),
            ),
            IslConstraintValue::OneOf(isl_type_references) => {
                let type_references = Constraint::resolve_type_references(
                    isl_version,
                    isl_type_references,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::OneOf(OneOfConstraint::new(type_references)))
            }
            IslConstraintValue::Not(type_reference) => {
                let type_id = IslTypeRef::resolve_type_reference(
                    isl_version,
                    type_reference,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::Not(NotConstraint::new(type_id)))
            }
            IslConstraintValue::Type(type_reference) => {
                let type_id = IslTypeRef::resolve_type_reference(
                    isl_version,
                    type_reference,
                    type_store,
                    pending_types,
                )?;
                Ok(Constraint::Type(TypeConstraint::new(type_id)))
            }
            IslConstraintValue::OrderedElements(isl_type_references) => {
                Ok(Constraint::OrderedElements(
                    OrderedElementsConstraint::resolve_from_isl_constraint(
                        isl_version,
                        isl_type_references,
                        type_store,
                        pending_types,
                    )?,
                ))
            }
            IslConstraintValue::Precision(precision_range) => {
                isl_require!(precision_range.lower() != &Limit::Inclusive(0) => "precision range must have non-zero values")?;
                Ok(Constraint::Precision(PrecisionConstraint::new(
                    precision_range.to_owned(),
                )))
            }
            IslConstraintValue::Regex(regex) => Ok(Constraint::Regex(RegexConstraint::from_isl(
                regex,
                isl_version,
            )?)),
            IslConstraintValue::Scale(scale_range) => Ok(Constraint::Scale(ScaleConstraint::new(
                scale_range.to_owned(),
            ))),
            IslConstraintValue::TimestampOffset(timestamp_offset) => {
                Ok(Constraint::TimestampOffset(TimestampOffsetConstraint::new(
                    timestamp_offset.valid_offsets().to_vec(),
                )))
            }
            IslConstraintValue::Exponent(exponent_range) => Ok(Constraint::Exponent(
                ExponentConstraint::new(exponent_range.to_owned()),
            )),
            IslConstraintValue::TimestampPrecision(timestamp_precision_range) => {
                Ok(Constraint::TimestampPrecision(
                    TimestampPrecisionConstraint::new(timestamp_precision_range.to_owned()),
                ))
            }
            IslConstraintValue::Utf8ByteLength(utf8_byte_length) => Ok(Constraint::Utf8ByteLength(
                Utf8ByteLengthConstraint::new(utf8_byte_length.to_owned()),
            )),
            IslConstraintValue::ValidValues(valid_values) => {
                Ok(Constraint::ValidValues(ValidValuesConstraint {
                    valid_values: valid_values.values().to_owned(),
                }))
            }
            IslConstraintValue::Unknown(constraint_name, element) => Ok(Constraint::Unknown(
                constraint_name.to_owned(),
                element.to_owned(),
            )),
        }
    }

    pub fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        match self {
            Constraint::AllOf(all_of) => all_of.validate(value, type_store, ion_path),
            Constraint::Annotations(annotations) => {
                annotations.validate(value, type_store, ion_path)
            }
            Constraint::Annotations2_0(annotations) => {
                annotations.validate(value, type_store, ion_path)
            }
            Constraint::AnyOf(any_of) => any_of.validate(value, type_store, ion_path),
            Constraint::ByteLength(byte_length) => {
                byte_length.validate(value, type_store, ion_path)
            }
            Constraint::CodepointLength(codepoint_length) => {
                codepoint_length.validate(value, type_store, ion_path)
            }
            Constraint::Contains(contains) => contains.validate(value, type_store, ion_path),
            Constraint::ContentClosed => {
                // No op
                // `content: closed` does not work as a constraint by its own, it needs to be used with other container constraints
                // e.g. `fields`
                // the validation for `content: closed` is done within these other constraints
                Ok(())
            }
            Constraint::ContainerLength(container_length) => {
                container_length.validate(value, type_store, ion_path)
            }
            Constraint::Element(element) => element.validate(value, type_store, ion_path),
            Constraint::FieldNames(field_names) => {
                field_names.validate(value, type_store, ion_path)
            }
            Constraint::Fields(fields) => fields.validate(value, type_store, ion_path),
            Constraint::Ieee754Float(ieee754_float) => {
                ieee754_float.validate(value, type_store, ion_path)
            }
            Constraint::Not(not) => not.validate(value, type_store, ion_path),
            Constraint::OneOf(one_of) => one_of.validate(value, type_store, ion_path),
            Constraint::Type(type_constraint) => {
                type_constraint.validate(value, type_store, ion_path)
            }
            Constraint::OrderedElements(ordered_elements) => {
                ordered_elements.validate(value, type_store, ion_path)
            }
            Constraint::Precision(precision) => precision.validate(value, type_store, ion_path),
            Constraint::Regex(regex) => regex.validate(value, type_store, ion_path),
            Constraint::Scale(scale) => scale.validate(value, type_store, ion_path),
            Constraint::Exponent(exponent) => exponent.validate(value, type_store, ion_path),
            Constraint::TimestampOffset(timestamp_offset) => {
                timestamp_offset.validate(value, type_store, ion_path)
            }
            Constraint::TimestampPrecision(timestamp_precision) => {
                timestamp_precision.validate(value, type_store, ion_path)
            }
            Constraint::Utf8ByteLength(utf8_byte_length) => {
                utf8_byte_length.validate(value, type_store, ion_path)
            }
            Constraint::ValidValues(valid_values) => {
                valid_values.validate(value, type_store, ion_path)
            }
            Constraint::Unknown(_, _) => {
                // No op
                // `Unknown` represents open content which can be ignored for validation
                Ok(())
            }
        }
    }
}

/// Implements an `all_of` constraint of Ion Schema
/// [all_of]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#all_of
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AllOfConstraint {
    type_references: Vec<TypeReference>,
}

impl AllOfConstraint {
    pub fn new(type_references: Vec<TypeReference>) -> Self {
        Self { type_references }
    }
}

impl ConstraintValidator for AllOfConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];
        let mut valid_types = vec![];
        for type_reference in &self.type_references {
            match type_reference.validate(value, type_store, ion_path) {
                Ok(_) => valid_types.push(type_reference.type_id()),
                Err(violation) => violations.push(violation),
            }
        }
        if !violations.is_empty() {
            return Err(Violation::with_violations(
                "all_of",
                ViolationCode::AllTypesNotMatched,
                format!(
                    "value matches {} types, expected {}",
                    valid_types.len(),
                    self.type_references.len()
                ),
                ion_path,
                violations,
            ));
        }
        Ok(())
    }
}

/// Implements an `any_of` constraint of Ion Schema
/// [any_of]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#any_of
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AnyOfConstraint {
    type_references: Vec<TypeReference>,
}

impl AnyOfConstraint {
    pub fn new(type_references: Vec<TypeReference>) -> Self {
        Self { type_references }
    }
}

impl ConstraintValidator for AnyOfConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];
        let mut valid_types = vec![];
        for type_reference in &self.type_references {
            match type_reference.validate(value, type_store, ion_path) {
                Ok(_) => valid_types.push(type_reference.type_id()),
                Err(violation) => violations.push(violation),
            }
        }
        let total_valid_types = valid_types.len();
        if total_valid_types == 0 {
            return Err(Violation::with_violations(
                "any_of",
                ViolationCode::NoTypesMatched,
                "value matches none of the types",
                ion_path,
                violations,
            ));
        }
        Ok(())
    }
}

/// Implements an `one_of` constraint of Ion Schema
/// [one_of]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#one_of
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OneOfConstraint {
    type_references: Vec<TypeReference>,
}

impl OneOfConstraint {
    pub fn new(type_references: Vec<TypeReference>) -> Self {
        Self { type_references }
    }
}

impl ConstraintValidator for OneOfConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];
        let mut valid_types = vec![];
        for type_reference in &self.type_references {
            match type_reference.validate(value, type_store, ion_path) {
                Ok(_) => valid_types.push(type_reference.type_id()),
                Err(violation) => violations.push(violation),
            }
        }
        let total_valid_types = valid_types.len();
        match total_valid_types {
            0 => Err(Violation::with_violations(
                "one_of",
                ViolationCode::NoTypesMatched,
                "value matches none of the types",
                ion_path,
                violations,
            )),
            1 => Ok(()),
            _ => Err(Violation::with_violations(
                "one_of",
                ViolationCode::MoreThanOneTypeMatched,
                format!("value matches {total_valid_types} types, expected 1"),
                ion_path,
                violations,
            )),
        }
    }
}

/// Implements a `not` constraint
/// [type]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#not
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NotConstraint {
    type_reference: TypeReference,
}

impl NotConstraint {
    pub fn new(type_reference: TypeReference) -> Self {
        Self { type_reference }
    }
}

impl ConstraintValidator for NotConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let violation = self.type_reference.validate(value, type_store, ion_path);
        match violation {
            Err(violation) => Ok(()),
            Ok(_) => {
                // if there were no violations for the types then not constraint was unsatisfied
                Err(Violation::new(
                    "not",
                    ViolationCode::TypeMatched,
                    "value unexpectedly matches type",
                    ion_path,
                ))
            }
        }
    }
}

/// Implements a `type` constraint
/// [type]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#type
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TypeConstraint {
    pub(crate) type_reference: TypeReference,
}

impl TypeConstraint {
    pub fn new(type_reference: TypeReference) -> Self {
        Self { type_reference }
    }
}

impl ConstraintValidator for TypeConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        self.type_reference.validate(value, type_store, ion_path)
    }
}

/// Implements an `ordered_elements` constraint of Ion Schema
/// [ordered_elements]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#ordered_elements
#[derive(Debug, Clone, PartialEq)]
pub struct OrderedElementsConstraint {
    nfa: OrderedElementsNfa,
}

impl OrderedElementsConstraint {
    pub fn new(type_references: Vec<VariablyOccurringTypeRef>) -> Self {
        let states: Vec<_> = type_references
            .into_iter()
            // TODO: See if we can potentially add a more informative description.
            .map(|ty| (ty, None))
            .collect();
        OrderedElementsConstraint {
            nfa: OrderedElementsNfa::new(states),
        }
    }

    fn resolve_from_isl_constraint(
        isl_version: IslVersion,
        type_references: &[IslVariablyOccurringTypeRef],
        type_store: &mut TypeStore,
        pending_types: &mut PendingTypes,
    ) -> IonSchemaResult<Self> {
        let resolved_types = type_references
            .iter()
            .map(|t| {
                // resolve type references and create variably occurring type reference with occurs range
                let var_type_ref = t.resolve_type_reference(isl_version, type_store, pending_types);
                // TODO: See if we can potentially add a more informative description.
                var_type_ref.map(|it| (it, None))
            })
            .collect::<IonSchemaResult<Vec<_>>>()?;

        Ok(OrderedElementsConstraint {
            nfa: OrderedElementsNfa::new(resolved_types),
        })
    }
}

impl ConstraintValidator for OrderedElementsConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let violations: Vec<Violation> = vec![];

        let element_iter = match value.as_sequence_iter() {
            Some(iter) => iter,
            None => {
                return Err(Violation::with_violations(
                    "ordered_elements",
                    ViolationCode::TypeMismatched,
                    format!(
                        "expected list, sexp, or document; found {}",
                        if value.is_null() {
                            format!("{value}")
                        } else {
                            format!("{}", value.ion_schema_type())
                        }
                    ),
                    ion_path,
                    violations,
                ));
            }
        };

        self.nfa.matches(element_iter, type_store, ion_path)
    }
}

/// Implements an `fields` constraint of Ion Schema
/// [fields]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#fields
#[derive(Debug, Clone, PartialEq)]
pub struct FieldsConstraint {
    fields: HashMap<String, VariablyOccurringTypeRef>,
    open_content: bool,
}

impl FieldsConstraint {
    pub fn new(fields: HashMap<String, VariablyOccurringTypeRef>, open_content: bool) -> Self {
        Self {
            fields,
            open_content,
        }
    }

    /// Provides boolean value indicating whether open content is allowed or not for the fields
    pub fn open_content(&self) -> bool {
        self.open_content
    }

    /// Tries to create an [Fields] constraint from the given Element
    fn resolve_from_isl_constraint(
        isl_version: IslVersion,
        fields: &HashMap<String, IslVariablyOccurringTypeRef>,
        type_store: &mut TypeStore,
        pending_types: &mut PendingTypes,
        open_content: bool, // Indicates if open content is allowed or not for the fields in the container
    ) -> IonSchemaResult<Self> {
        let resolved_fields: HashMap<String, VariablyOccurringTypeRef> = fields
            .iter()
            .map(|(f, t)| {
                // resolve type references and create variably occurring type reference with occurs range
                // default `occurs` field value for `fields` constraint is `occurs: optional` or `occurs: range::[0, 1]`
                t.resolve_type_reference(isl_version, type_store, pending_types)
                    .map(|variably_occurring_type_ref| (f.to_owned(), variably_occurring_type_ref))
            })
            .collect::<IonSchemaResult<HashMap<String, VariablyOccurringTypeRef>>>()?;
        Ok(FieldsConstraint::new(resolved_fields, open_content))
    }
}

impl ConstraintValidator for FieldsConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];

        // get struct value
        let ion_struct = value
            .expect_element_of_type(&[IonType::Struct], "fields", ion_path)?
            .as_struct()
            .unwrap();

        // Verify if open content exists in the struct fields
        if !self.open_content() {
            for (field_name, value) in ion_struct.iter() {
                if !self.fields.contains_key(field_name.text().unwrap()) {
                    violations.push(Violation::new(
                        "fields",
                        ViolationCode::InvalidOpenContent,
                        format!("Found open content in the struct: {field_name}: {value}"),
                        ion_path,
                    ));
                }
            }
        }

        // get the values corresponding to the field_name and perform occurs_validation based on the type_def
        for (field_name, variably_occurring_type_ref) in &self.fields {
            let type_reference = variably_occurring_type_ref.type_ref();
            let values: Vec<&Element> = ion_struct.get_all(field_name).collect();

            // add parent value for current field in ion path
            ion_path.push(IonPathElement::Field(field_name.to_owned()));

            // perform occurs validation for type_def for all values of the given field_name
            let occurs_range: &UsizeRange = variably_occurring_type_ref.occurs_range();

            // verify if values follow occurs_range constraint
            if !occurs_range.contains(&values.len()) {
                violations.push(Violation::new(
                    "fields",
                    ViolationCode::TypeMismatched,
                    format!(
                        "Expected {} of field {}: found {}",
                        occurs_range,
                        field_name,
                        values.len()
                    ),
                    ion_path,
                ));
            }

            // verify if all the values for this field name are valid according to type_def
            for value in values {
                let schema_element: IonSchemaElement = value.into();
                if let Err(violation) =
                    type_reference.validate(&schema_element, type_store, ion_path)
                {
                    violations.push(violation);
                }
            }

            // remove current field from list of parents
            ion_path.pop();
        }

        // return error if there were any violation found during validation
        if !violations.is_empty() {
            return Err(Violation::with_violations(
                "fields",
                ViolationCode::FieldsNotMatched,
                "value didn't satisfy fields constraint",
                ion_path,
                violations,
            ));
        }
        Ok(())
    }
}

/// Implements an `field_names` constraint of Ion Schema
/// [field_names]: https://amazon-ion.github.io/ion-schema/docs/isl-2-0/spec#field_names
#[derive(Debug, Clone, PartialEq)]
pub struct FieldNamesConstraint {
    type_reference: TypeReference,
    requires_distinct: bool,
}

impl FieldNamesConstraint {
    pub fn new(type_reference: TypeReference, requires_distinct: bool) -> Self {
        Self {
            type_reference,
            requires_distinct,
        }
    }
}

impl ConstraintValidator for FieldNamesConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];

        // create a set for checking duplicate field names
        let mut field_name_set = HashSet::new();

        let ion_struct = value
            .expect_element_of_type(&[IonType::Struct], "field_names", ion_path)?
            .as_struct()
            .unwrap();

        for (field_name, _) in ion_struct.iter() {
            ion_path.push(IonPathElement::Field(field_name.text().unwrap().to_owned()));
            let field_name_symbol_as_element = Element::symbol(field_name);
            let schema_element: IonSchemaElement = (&field_name_symbol_as_element).into();

            if let Err(violation) =
                self.type_reference
                    .validate(&schema_element, type_store, ion_path)
            {
                violations.push(violation);
            }
            if self.requires_distinct && !field_name_set.insert(field_name.text().unwrap()) {
                violations.push(Violation::new(
                    "field_names",
                    ViolationCode::FieldNamesNotDistinct,
                    format!(
                        "expected distinct field names but found duplicate field name {field_name}",
                    ),
                    ion_path,
                ))
            }
            ion_path.pop();
        }

        if !violations.is_empty() {
            return Err(Violation::with_violations(
                "field_names",
                ViolationCode::FieldNamesMismatched,
                "one or more field names don't satisfy field_names constraint",
                ion_path,
                violations,
            ));
        }
        Ok(())
    }
}

/// Implements Ion Schema's `contains` constraint
/// [contains]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#contains
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContainsConstraint {
    // TODO: convert this into a HashSet once we have an implementation of Hash for Element in ion-rust
    // Reference ion-rust issue: https://github.com/amazon-ion/ion-rust/issues/220
    values: Vec<Element>,
}

impl ContainsConstraint {
    pub fn new(values: Vec<Element>) -> Self {
        Self { values }
    }
}

impl ConstraintValidator for ContainsConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let values: Vec<IonData<&Element>> = if let Some(element_iter) = value.as_sequence_iter() {
            element_iter.map(IonData::from).collect()
        } else if let Some(strukt) = value.as_struct() {
            strukt.fields().map(|(k, v)| v).map(IonData::from).collect()
        } else {
            return Err(Violation::new(
                "contains",
                ViolationCode::TypeMismatched,
                format!(
                    "expected list/sexp/struct/document found {}",
                    if value.is_null() {
                        format!("{value}")
                    } else {
                        format!("{}", value.ion_schema_type())
                    }
                ),
                ion_path,
            ));
        };

        // add all the missing values found during validation
        let mut missing_values = vec![];

        // for each value in expected values if it does not exist in ion sequence
        // then add it to missing_values to keep track of missing values
        for expected_value in self.values.iter() {
            let expected = expected_value.into();
            if !values.contains(&expected) {
                missing_values.push(expected_value);
            }
        }

        // return Violation if there were any values added to the missing values vector
        if !missing_values.is_empty() {
            return Err(Violation::new(
                "contains",
                ViolationCode::MissingValue,
                format!("{value} has missing value(s): {missing_values:?}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements an `container_length` constraint of Ion Schema
/// [container_length]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#container_length
#[derive(Debug, Clone, PartialEq)]
pub struct ContainerLengthConstraint {
    length_range: UsizeRange,
}

impl ContainerLengthConstraint {
    pub fn new(length_range: UsizeRange) -> Self {
        Self { length_range }
    }

    pub fn length(&self) -> &UsizeRange {
        &self.length_range
    }
}

impl ConstraintValidator for ContainerLengthConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get the size of given value container
        let size = if let Some(element_iter) = value.as_sequence_iter() {
            element_iter.count()
        } else if let Some(strukt) = value.as_struct() {
            strukt.fields().map(|(k, v)| v).count()
        } else {
            return Err(Violation::new(
                "container_length",
                ViolationCode::TypeMismatched,
                if value.is_null() {
                    format!("expected a container found {value}")
                } else {
                    format!(
                        "expected a container (a list/sexp/struct) but found {}",
                        value.ion_schema_type()
                    )
                },
                ion_path,
            ));
        };

        // get isl length as a range
        let length_range: &UsizeRange = self.length();

        // return a Violation if the container size didn't follow container_length constraint
        if !length_range.contains(&size) {
            return Err(Violation::new(
                "container_length",
                ViolationCode::InvalidLength,
                format!("expected container length {length_range} found {size}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `byte_length` constraint
/// [byte_length]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#byte_length
#[derive(Debug, Clone, PartialEq)]
pub struct ByteLengthConstraint {
    length_range: UsizeRange,
}

impl ByteLengthConstraint {
    pub fn new(length_range: UsizeRange) -> Self {
        Self { length_range }
    }

    pub fn length(&self) -> &UsizeRange {
        &self.length_range
    }
}

impl ConstraintValidator for ByteLengthConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get the size of given bytes
        let size = value
            .expect_element_of_type(&[IonType::Blob, IonType::Clob], "byte_length", ion_path)?
            .as_lob()
            .unwrap()
            .len();

        // get isl length as a range
        let length_range: &UsizeRange = self.length();

        // return a Violation if the clob/blob size didn't follow byte_length constraint
        if !length_range.contains(&size) {
            return Err(Violation::new(
                "byte_length",
                ViolationCode::InvalidLength,
                format!("expected byte length {length_range} found {size}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements an `codepoint_length` constraint of Ion Schema
/// [codepoint_length]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#codepoint_length
#[derive(Debug, Clone, PartialEq)]
pub struct CodepointLengthConstraint {
    length_range: UsizeRange,
}

impl CodepointLengthConstraint {
    pub fn new(length_range: UsizeRange) -> Self {
        Self { length_range }
    }

    pub fn length(&self) -> &UsizeRange {
        &self.length_range
    }
}

impl ConstraintValidator for CodepointLengthConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get the size of given string/symbol Unicode codepoints
        let size = value
            .expect_element_of_type(
                &[IonType::String, IonType::Symbol],
                "codepoint_length",
                ion_path,
            )?
            .as_text()
            .unwrap()
            .chars()
            .count();

        // get isl length as a range
        let length_range: &UsizeRange = self.length();

        // return a Violation if the string/symbol codepoint size didn't follow codepoint_length constraint
        if !length_range.contains(&size) {
            return Err(Violation::new(
                "codepoint_length",
                ViolationCode::InvalidLength,
                format!("expected codepoint length {length_range} found {size}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements the `element` constraint
/// [element]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#element
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ElementConstraint {
    type_reference: TypeReference,
    /// This field is used for ISL 2.0 and it represents whether validation for distinct elements is required or not.
    /// For ISL 1.0 this is always false as it doesn't support distinct elements validation.
    required_distinct_elements: bool,
}

impl ElementConstraint {
    pub fn new(type_reference: TypeReference, required_distinct_elements: bool) -> Self {
        Self {
            type_reference,
            required_distinct_elements,
        }
    }
}

impl ConstraintValidator for ElementConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut violations: Vec<Violation> = vec![];

        // create a set for checking duplicate elements
        let mut element_set = vec![];

        // get elements for given container in the form (ion_path_element, element_value)
        let elements: Vec<(IonPathElement, &Element)> =
            if let Some(element_iter) = value.as_sequence_iter() {
                element_iter
                    .enumerate()
                    .map(|(index, val)| (IonPathElement::Index(index), val))
                    .collect()
            } else if let Some(strukt) = value.as_struct() {
                strukt
                    .fields()
                    .map(|(name, val)| (IonPathElement::Field(name.to_string()), val))
                    .collect()
            } else {
                // Check for null container
                if value.is_null() {
                    return Err(Violation::new(
                        "element",
                        ViolationCode::TypeMismatched,
                        format!("expected a container but found {value}"),
                        ion_path,
                    ));
                }
                // return Violation if value is not an Ion container
                return Err(Violation::new(
                    "element",
                    ViolationCode::TypeMismatched,
                    format!(
                        "expected a container (a list/sexp/struct) but found {}",
                        value.ion_schema_type()
                    ),
                    ion_path,
                ));
            };

        // validate element constraint
        for (ion_path_element, val) in elements {
            ion_path.push(ion_path_element);
            let schema_element: IonSchemaElement = val.into();

            if let Err(violation) =
                self.type_reference
                    .validate(&schema_element, type_store, ion_path)
            {
                violations.push(violation);
            }
            if self.required_distinct_elements && element_set.contains(&val) {
                violations.push(Violation::new(
                    "element",
                    ViolationCode::ElementNotDistinct,
                    format!("expected distinct elements but found duplicate element {val}",),
                    ion_path,
                ))
            }
            element_set.push(val);
            ion_path.pop();
        }

        if !violations.is_empty() {
            return Err(Violation::with_violations(
                "element",
                ViolationCode::ElementMismatched,
                "one or more elements don't satisfy element constraint",
                ion_path,
                violations,
            ));
        }
        Ok(())
    }
}

/// Implements the `annotations` constraint
/// [annotations]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#annotations
// This is used for both simple and standard syntax of annotations constraint.
// The simple syntax will be converted to a standard syntax for removing complexity in the validation logic.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AnnotationsConstraint2_0 {
    type_ref: TypeReference,
}

impl AnnotationsConstraint2_0 {
    pub fn new(type_ref: TypeReference) -> Self {
        Self { type_ref }
    }
}

impl ConstraintValidator for AnnotationsConstraint2_0 {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        if let Some(element) = value.as_element() {
            let annotations: Vec<Element> =
                element.annotations().iter().map(Element::symbol).collect();
            let annotations_element: Element = ion_rs::Value::List(annotations.into()).into();
            let annotations_ion_schema_element = IonSchemaElement::from(&annotations_element);

            self.type_ref
                .validate(&annotations_ion_schema_element, type_store, ion_path)
                .map_err(|v| {
                    Violation::with_violations(
                        "annotations",
                        ViolationCode::AnnotationMismatched,
                        "one or more annotations don't satisfy annotations constraint",
                        ion_path,
                        vec![v],
                    )
                })
        } else {
            // document type can not have annotations
            Err(Violation::new(
                "annotations",
                ViolationCode::AnnotationMismatched,
                "annotations constraint is not applicable for document type",
                ion_path,
            ))
        }
    }
}

/// Implements the `annotations` constraint
/// [annotations]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#annotations
// The `required` annotation provided on the list of annotations is not represented here,
// requirement of an annotation is represented in the annotation itself by the field `is_required` of `Annotation` struct.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AnnotationsConstraint {
    is_closed: bool,
    is_ordered: bool,
    annotations: Vec<Annotation>,
}

impl AnnotationsConstraint {
    pub fn new(is_closed: bool, is_ordered: bool, annotations: Vec<Annotation>) -> Self {
        Self {
            is_closed,
            is_ordered,
            annotations,
        }
    }

    // Find the required expected annotation from value annotations
    // This is a helper method used by validate_ordered_annotations
    pub fn find_expected_annotation<'a, I: Iterator<Item = &'a str>>(
        &self,
        value_annotations: &mut Peekable<I>,
        expected_annotation: &Annotation,
    ) -> bool {
        // As there are open content possible for annotations that doesn't have list-level `closed` annotation
        // traverse through the next annotations to find this expected, ordered and required annotation
        while Option::is_some(&value_annotations.peek()) && !self.is_closed {
            if expected_annotation.value() == value_annotations.next().unwrap() {
                return true;
            }
        }

        // if we didn't find the expected annotation return false
        false
    }

    pub fn validate_ordered_annotations(
        &self,
        value: &Element,
        type_store: &TypeStore,
        violations: Vec<Violation>,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let mut value_annotations = value
            .annotations()
            .iter()
            .map(|sym| sym.text().unwrap())
            .peekable();

        // iterate over the expected annotations and see if there are any unexpected value annotations found
        for expected_annotation in &self.annotations {
            if let Some(actual_annotation) = value_annotations.peek() {
                if expected_annotation.is_required()
                    && expected_annotation.value() != actual_annotation
                {
                    // iterate over the actual value annotations to find the required expected annotation
                    if !self.find_expected_annotation(&mut value_annotations, expected_annotation) {
                        // missing required expected annotation
                        return Err(Violation::new(
                            "annotations",
                            ViolationCode::AnnotationMismatched,
                            "annotations don't match expectations",
                            ion_path,
                        ));
                    }
                } else if expected_annotation.value() == actual_annotation {
                    let _ = value_annotations.next(); // consume the annotation if its equal to the expected annotation
                }
            } else if expected_annotation.is_required() {
                // we already exhausted value annotations and didn't find the required expected annotation
                return Err(Violation::new(
                    "annotations",
                    ViolationCode::AnnotationMismatched,
                    "annotations don't match expectations",
                    ion_path,
                ));
            }
        }

        if self.is_closed && Option::is_some(&value_annotations.peek()) {
            // check if there are still annotations left at the end of the list
            return Err(Violation::with_violations(
                "annotations",
                ViolationCode::AnnotationMismatched,
                // unwrap as we already verified with peek that there is a value
                format!(
                    "Unexpected annotations found {}",
                    value_annotations.next().unwrap()
                ),
                ion_path,
                violations,
            ));
        }

        Ok(())
    }

    pub fn validate_unordered_annotations(
        &self,
        value: &Element,
        type_store: &TypeStore,
        violations: Vec<Violation>,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // This will be used by a violation to to return all the missing annotations
        let mut missing_annotations: Vec<&Annotation> = vec![];

        let value_annotations: Vec<&str> = value
            .annotations()
            .iter()
            .map(|sym| sym.text().unwrap())
            .collect();

        for expected_annotation in &self.annotations {
            // verify if the expected_annotation is required and if it matches with value annotation
            if expected_annotation.is_required()
                && !value.annotations().contains(expected_annotation.value())
            {
                missing_annotations.push(expected_annotation);
            }
        }

        // if missing_annotations is not empty return violation
        if !missing_annotations.is_empty() {
            return Err(Violation::with_violations(
                "annotations",
                ViolationCode::MissingAnnotation,
                format!("missing annotation(s): {missing_annotations:?}"),
                ion_path,
                violations,
            ));
        }

        // if the annotations is annotated with `closed` at list-level then verify
        // there are no unexpected annotations in the value annotations
        if self.is_closed
            && !value_annotations.iter().all(|v| {
                self.annotations
                    .iter()
                    .any(|expected_ann| v == expected_ann.value())
            })
        {
            return Err(Violation::with_violations(
                "annotations",
                ViolationCode::UnexpectedAnnotation,
                "found one or more unexpected annotations",
                ion_path,
                violations,
            ));
        }

        Ok(())
    }
}

impl ConstraintValidator for AnnotationsConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        let violations: Vec<Violation> = vec![];

        if let Some(element) = value.as_element() {
            // validate annotations that have list-level `ordered` annotation
            if self.is_ordered {
                return self
                    .validate_ordered_annotations(element, type_store, violations, ion_path);
            }

            // validate annotations that does not have list-level `ordered` annotation
            self.validate_unordered_annotations(element, type_store, violations, ion_path)
        } else {
            // document type can not have annotations
            Err(Violation::new(
                "annotations",
                ViolationCode::AnnotationMismatched,
                "annotations constraint is not applicable for document type",
                ion_path,
            ))
        }
    }
}

/// Implements Ion Schema's `precision` constraint
/// [precision]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#precision
#[derive(Debug, Clone, PartialEq)]
pub struct PrecisionConstraint {
    precision_range: U64Range,
}

impl PrecisionConstraint {
    pub fn new(precision_range: U64Range) -> Self {
        Self { precision_range }
    }

    pub fn precision(&self) -> &U64Range {
        &self.precision_range
    }
}

impl ConstraintValidator for PrecisionConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get precision of decimal value
        let value_precision = value
            .expect_element_of_type(&[IonType::Decimal], "precision", ion_path)?
            .as_decimal()
            .unwrap()
            .precision();

        // get isl decimal precision as a range
        let precision_range: &U64Range = self.precision();

        // return a Violation if the value didn't follow precision constraint
        if !precision_range.contains(&value_precision) {
            return Err(Violation::new(
                "precision",
                ViolationCode::InvalidLength,
                format!("expected precision {precision_range} found {value_precision}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `scale` constraint
/// [scale]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#scale
#[derive(Debug, Clone, PartialEq)]
pub struct ScaleConstraint {
    scale_range: I64Range,
}

impl ScaleConstraint {
    pub fn new(scale_range: I64Range) -> Self {
        Self { scale_range }
    }

    pub fn scale(&self) -> &I64Range {
        &self.scale_range
    }
}

impl ConstraintValidator for ScaleConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get scale of decimal value
        let value_scale = value
            .expect_element_of_type(&[IonType::Decimal], "scale", ion_path)?
            .as_decimal()
            .unwrap()
            .scale();

        // get isl decimal scale as a range
        let scale_range: &I64Range = self.scale();

        // return a Violation if the value didn't follow scale constraint
        if !scale_range.contains(&value_scale) {
            return Err(Violation::new(
                "scale",
                ViolationCode::InvalidLength,
                format!("expected scale {scale_range} found {value_scale}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `exponent` constraint
/// [exponent]: https://amazon-ion.github.io/ion-schema/docs/isl-2-0/spec#exponent
#[derive(Debug, Clone, PartialEq)]
pub struct ExponentConstraint {
    exponent_range: I64Range,
}

impl ExponentConstraint {
    pub fn new(exponent_range: I64Range) -> Self {
        Self { exponent_range }
    }

    pub fn exponent(&self) -> &I64Range {
        &self.exponent_range
    }
}

impl ConstraintValidator for ExponentConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get exponent of decimal value
        let value_exponent = value
            .expect_element_of_type(&[IonType::Decimal], "exponent", ion_path)?
            .as_decimal()
            .unwrap()
            .scale()
            .neg();

        // get isl decimal exponent as a range
        let exponent_range: &I64Range = self.exponent();

        // return a Violation if the value didn't follow exponent constraint
        if !exponent_range.contains(&value_exponent) {
            return Err(Violation::new(
                "exponent",
                ViolationCode::InvalidLength,
                format!("expected exponent {exponent_range} found {value_exponent}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `timestamp_precision` constraint
/// [timestamp_precision]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#timestamp_precision
#[derive(Debug, Clone, PartialEq)]
pub struct TimestampPrecisionConstraint {
    timestamp_precision_range: TimestampPrecisionRange,
}

impl TimestampPrecisionConstraint {
    pub fn new(scale_range: TimestampPrecisionRange) -> Self {
        Self {
            timestamp_precision_range: scale_range,
        }
    }

    pub fn timestamp_precision(&self) -> &TimestampPrecisionRange {
        &self.timestamp_precision_range
    }
}

impl ConstraintValidator for TimestampPrecisionConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get timestamp value
        let timestamp_value = value
            .expect_element_of_type(&[IonType::Timestamp], "timestamp_precision", ion_path)?
            .as_timestamp()
            .unwrap();

        // get isl timestamp precision as a range
        let precision_range: &TimestampPrecisionRange = self.timestamp_precision();
        let precision = &TimestampPrecision::from_timestamp(&timestamp_value);
        // return a Violation if the value didn't follow timestamp precision constraint
        if !precision_range.contains(precision) {
            return Err(Violation::new(
                "precision",
                ViolationCode::InvalidLength,
                format!("expected precision {precision_range} found {precision:?}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `valid_values` constraint
/// [valid_values]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#valid_values
#[derive(Debug, Clone, PartialEq)]
pub struct ValidValuesConstraint {
    valid_values: Vec<ValidValue>,
}

impl ValidValuesConstraint {
    pub fn new(valid_values: Vec<ValidValue>, isl_version: IslVersion) -> IonSchemaResult<Self> {
        Ok(Self { valid_values })
    }
}

impl Display for ValidValuesConstraint {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
        write!(f, "[ ")?;
        let mut itr = self.valid_values.iter();
        if let Some(item) = itr.next() {
            write!(f, "{item}")?;
        }
        for item in itr {
            write!(f, ", {item}")?;
        }
        write!(f, " ]")
    }
}

impl ConstraintValidator for ValidValuesConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        match value.as_element() {
            Some(element) => {
                for valid_value in &self.valid_values {
                    let does_match = match valid_value {
                        ValidValue::Element(valid_value) => {
                            // this comparison uses the Ion equivalence based on Ion specification
                            IonData::eq(valid_value, element.value())
                        }
                        ValidValue::NumberRange(range) => match element.any_number_as_decimal() {
                            Some(d) => range.contains(&d),
                            _ => false,
                        },
                        ValidValue::TimestampRange(range) => {
                            if let Value::Timestamp(t) = element.value() {
                                range.contains(t)
                            } else {
                                false
                            }
                        }
                    };
                    if does_match {
                        return Ok(());
                    }
                }
                Err(Violation::new(
                    "valid_values",
                    ViolationCode::InvalidValue,
                    format!(
                        "expected valid_values to be from {}, found {}",
                        &self, element
                    ),
                    ion_path,
                ))
            }
            _ => Err(Violation::new(
                "valid_values",
                ViolationCode::InvalidValue,
                format!(
                    "expected valid_values to be from {}, found {}",
                    &self, value
                ),
                ion_path,
            )),
        }
    }
}

/// Implements Ion Schema's `regex` constraint
/// [regex]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#regex
#[derive(Debug, Clone)]
pub struct RegexConstraint {
    expression: Regex,
    case_insensitive: bool,
    multiline: bool,
}

impl RegexConstraint {
    fn new(expression: Regex, case_insensitive: bool, multiline: bool) -> Self {
        Self {
            expression,
            case_insensitive,
            multiline,
        }
    }

    fn from_isl(isl_regex: &IslRegexConstraint, isl_version: IslVersion) -> IonSchemaResult<Self> {
        let pattern =
            RegexConstraint::convert_to_pattern(isl_regex.expression().to_owned(), isl_version)?;

        let regex = RegexBuilder::new(pattern.as_str())
            .case_insensitive(isl_regex.case_insensitive())
            .multi_line(isl_regex.multi_line())
            .build()
            .map_err(|e| {
                invalid_schema_error_raw(format!("Invalid regex {}", isl_regex.expression()))
            })?;

        Ok(RegexConstraint::new(
            regex,
            isl_regex.case_insensitive(),
            isl_regex.multi_line(),
        ))
    }

    /// Converts given string to a pattern based on regex features supported by Ion Schema Specification
    /// For more information: `<https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#regex>`
    fn convert_to_pattern(expression: String, isl_version: IslVersion) -> IonSchemaResult<String> {
        let mut sb = String::new();
        let mut si = expression.as_str().chars().peekable();

        while let Some(ch) = si.next() {
            match ch {
                '[' => {
                    // push the starting bracket `[` to the result string
                    // and then parse the next characters using parse_char_class
                    sb.push(ch);
                    RegexConstraint::parse_char_class(&mut sb, &mut si, isl_version)?;
                }
                '(' => {
                    sb.push(ch);
                    if let Some(ch) = si.next() {
                        if ch == '?' {
                            return invalid_schema_error(format!("invalid character {ch}"));
                        }
                        sb.push(ch)
                    }
                }
                '\\' => {
                    if let Some(ch) = si.next() {
                        match ch {
                            // Note: Ion text a backslash must itself be escaped, so correct escaping
                            // of below characters requires two backslashes, e.g.: \\.
                            '.' | '^' | '$' | '|' | '?' | '*' | '+' | '\\' | '[' | ']' | '('
                            | ')' | '{' | '}' | 'w' | 'W' | 'd' | 'D' => {
                                sb.push('\\');
                                sb.push(ch)
                            }
                            's' => sb.push_str("[ \\f\\n\\r\\t]"),
                            'S' => sb.push_str("[^ \\f\\n\\r\\t]"),
                            _ => {
                                return invalid_schema_error(format!(
                                    "invalid escape character {ch}",
                                ))
                            }
                        }
                    }
                }
                // TODO: remove below match statement once we have fixed issue: https://github.com/amazon-ion/ion-rust/issues/399
                '\r' => sb.push('\n'), // Replace '\r' with '\n'
                _ => sb.push(ch),
            }
            RegexConstraint::parse_quantifier(&mut sb, &mut si)?;
        }

        Ok(sb)
    }

    fn parse_char_class(
        sb: &mut String,
        si: &mut Peekable<Chars<'_>>,
        isl_version: IslVersion,
    ) -> IonSchemaResult<()> {
        while let Some(ch) = si.next() {
            sb.push(ch);
            match ch {
                '&' => {
                    if si.peek() == Some(&'&') {
                        return invalid_schema_error("'&&' is not supported in a character class");
                    }
                }
                '[' => return invalid_schema_error("'[' must be escaped within a character class"),
                '\\' => {
                    if let Some(ch2) = si.next() {
                        match ch2 {
                            // escaped `[` or ']' are allowed within character class
                            '[' | ']' | '\\' => sb.push(ch2),
                            'd' | 's' | 'w' | 'D' | 'S' | 'W' => {
                                match isl_version {
                                    IslVersion::V1_0 => {
                                        // returns an error for ISL 1.0 as it does not support pre-defined char classes (i.e., \d, \s, \w)
                                        return invalid_schema_error(format!(
                                            "invalid sequence '{:?}' in character class",
                                            si
                                        ));
                                    }
                                    IslVersion::V2_0 => {
                                        // Change \w and \W to be [a-zA-Z0-9_] and [^a-zA-Z0-9_] respectively
                                        // Since `regex` supports unicode perl style character classes,
                                        // i.e. \w is represented as (\p{Alphabetic} + \p{M} + \d + \p{Pc} + \p{Join_Control})
                                        if ch2 == 'w' {
                                            sb.pop();
                                            sb.push_str(r"[a-zA-Z0-9_]");
                                        } else if ch2 == 'W' {
                                            sb.pop();
                                            sb.push_str(r"[^a-zA-Z0-9_]");
                                        } else {
                                            sb.push(ch2);
                                        }
                                    }
                                }
                            }
                            _ => {
                                return invalid_schema_error(format!(
                                    "invalid sequence '\\{ch2}' in character class"
                                ))
                            }
                        }
                    }
                }
                ']' => return Ok(()),
                _ => {}
            }
        }

        invalid_schema_error("character class missing ']'")
    }

    fn parse_quantifier(sb: &mut String, si: &mut Peekable<Chars<'_>>) -> IonSchemaResult<()> {
        let initial_length = sb.len();
        if let Some(ch) = si.peek().cloned() {
            match ch {
                '?' | '*' | '+' => {
                    if let Some(ch) = si.next() {
                        sb.push(ch);
                    }
                }
                '{' => {
                    // we know next is `{` so unwrap it and add it to the result string
                    let ch = si.next().unwrap();
                    sb.push(ch);
                    // process occurrences specified within `{` and `}`
                    let mut complete = false;
                    for ch in si.by_ref() {
                        match ch {
                            '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | ',' => {
                                sb.push(ch)
                            }
                            '}' => {
                                sb.push(ch);
                                // at this point occurrences are completely specified
                                complete = true;
                                break;
                            }
                            _ => return invalid_schema_error(format!("invalid character {ch}")),
                        }
                    }

                    if !complete {
                        return invalid_schema_error("range quantifier missing '}'");
                    }
                }
                _ => {}
            }
            if sb.len() > initial_length {
                if let Some(ch) = si.peek().cloned() {
                    match ch {
                        '?' => return invalid_schema_error(format!("invalid character {ch}")),

                        '+' => return invalid_schema_error(format!("invalid character {ch}")),
                        _ => {}
                    }
                }
            }
        }

        Ok(())
    }
}

impl ConstraintValidator for RegexConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get string value and return violation if its not a string or symbol type
        let string_value = value
            .expect_element_of_type(&[IonType::String, IonType::Symbol], "regex", ion_path)?
            .as_text()
            .unwrap();

        // create regular expression
        let re = Regex::new(r"\r").unwrap();
        let result = re.replace_all(string_value, "\n");
        let value = result.to_string();

        // verify if given value matches regular expression
        if !self.expression.is_match(value.as_str()) {
            return Err(Violation::new(
                "regex",
                ViolationCode::RegexMismatched,
                format!("{} doesn't match regex {}", value, self.expression),
                ion_path,
            ));
        }

        Ok(())
    }
}

impl PartialEq for RegexConstraint {
    fn eq(&self, other: &Self) -> bool {
        self.expression.as_str().eq(other.expression.as_str())
            && self.case_insensitive == other.case_insensitive
            && self.multiline == other.multiline
    }
}

/// Implements Ion Schema's `utf8_byte_length` constraint
/// [utf8_byte_length]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#utf8_byte_length
#[derive(Debug, Clone, PartialEq)]
pub struct Utf8ByteLengthConstraint {
    length_range: UsizeRange,
}

impl Utf8ByteLengthConstraint {
    pub fn new(length_range: UsizeRange) -> Self {
        Self { length_range }
    }

    pub fn length(&self) -> &UsizeRange {
        &self.length_range
    }
}

impl ConstraintValidator for Utf8ByteLengthConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get the size of given bytes
        let size = value
            .expect_element_of_type(
                &[IonType::String, IonType::Symbol],
                "utf8_byte_length",
                ion_path,
            )?
            .as_text()
            .unwrap()
            .len();

        // get isl length as a range
        let length_range: &UsizeRange = self.length();

        // return a Violation if the string/symbol size didn't follow utf8_byte_length constraint
        if !length_range.contains(&size) {
            return Err(Violation::new(
                "utf8_byte_length",
                ViolationCode::InvalidLength,
                format!("expected utf8 byte length {length_range} found {size}"),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `timestamp_offset` constraint
/// [timestamp_offset]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#timestamp_offset
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TimestampOffsetConstraint {
    valid_offsets: Vec<TimestampOffset>,
}

impl TimestampOffsetConstraint {
    pub fn new(valid_offsets: Vec<TimestampOffset>) -> Self {
        Self { valid_offsets }
    }

    pub fn valid_offsets(&self) -> &Vec<TimestampOffset> {
        &self.valid_offsets
    }
}

impl ConstraintValidator for TimestampOffsetConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get timestamp value
        let timestamp_value = value
            .expect_element_of_type(&[IonType::Timestamp], "timestamp_offset", ion_path)?
            .as_timestamp()
            .unwrap();

        // get isl timestamp precision as a range
        let valid_offsets: &Vec<TimestampOffset> = self.valid_offsets();

        // return a Violation if the value didn't follow timestamp precision constraint
        if !valid_offsets.contains(&timestamp_value.offset().into()) {
            let formatted_valid_offsets: Vec<String> =
                valid_offsets.iter().map(|t| format!("{t}")).collect();

            return Err(Violation::new(
                "timestamp_offset",
                ViolationCode::InvalidLength,
                format!(
                    "expected timestamp offset from {:?} found {}",
                    formatted_valid_offsets,
                    <Option<i32> as Into<TimestampOffset>>::into(timestamp_value.offset())
                ),
                ion_path,
            ));
        }

        Ok(())
    }
}

/// Implements Ion Schema's `ieee754_float` constraint
/// [ieee754_float]: https://amazon-ion.github.io/ion-schema/docs/isl-2-0/spec#ieee754_float
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Ieee754FloatConstraint {
    interchange_format: Ieee754InterchangeFormat,
}

impl Ieee754FloatConstraint {
    pub fn new(interchange_format: Ieee754InterchangeFormat) -> Self {
        Self { interchange_format }
    }

    pub fn interchange_format(&self) -> Ieee754InterchangeFormat {
        self.interchange_format
    }
}

impl ConstraintValidator for Ieee754FloatConstraint {
    fn validate(
        &self,
        value: &IonSchemaElement,
        type_store: &TypeStore,
        ion_path: &mut IonPath,
    ) -> ValidationResult {
        // get ieee interchange format value
        let float_value = value
            .expect_element_of_type(&[IonType::Float], "ieee754_float", ion_path)?
            .as_float()
            .unwrap();

        if !float_value.is_finite() {
            return Ok(());
        }

        let is_valid = match self.interchange_format {
            Ieee754InterchangeFormat::Binary16 => {
                half::f16::from_f64(float_value).to_f64() == float_value
            }
            Ieee754InterchangeFormat::Binary32 => float_value
                .to_f32()
                .and_then(|f32_value| f32_value.to_f64().map(|f64_value| f64_value == float_value))
                .unwrap_or(false),
            Ieee754InterchangeFormat::Binary64 => true,
        };

        if is_valid {
            Ok(())
        } else {
            Err(Violation::new(
                "ieee754_float",
                ViolationCode::InvalidIeee754Float,
                format!(
                    "value cannot be losslessly represented by the IEEE-754 {} interchange format.",
                    self.interchange_format
                ),
                ion_path,
            ))
        }
    }
}