Skip to main content

CompiledSchema

Struct CompiledSchema 

Source
#[non_exhaustive]
pub struct CompiledSchema {
Show 13 fields pub validations: Vec<Result<CompilationResult, CompilationError>>, pub properties: HashMap<String, CompiledSchema>, pub items: Option<Box<CompiledSchema>>, pub additional_properties: Option<Box<CompiledSchema>>, pub format: SchemaFormat, pub all_of: Vec<CompiledSchema>, pub one_of: Vec<CompiledSchema>, pub any_of: Vec<CompiledSchema>, pub max_length: Option<u64>, pub max_items: Option<u64>, pub max_properties: Option<u64>, pub preserve_unknown_fields: bool, pub embedded_resource: bool,
}
Available on crate feature validation only.
Expand description

A pre-compiled schema tree. Compile once with compile_schema, then validate many objects via Validator::validate_compiled.

§Note

CompiledSchema is not Clone because cel::Program is !Clone. Wrap in Arc for shared ownership across threads.

#[non_exhaustive]: an output type the crate constructs; new fields may be added without a breaking change. Read its fields directly or via the accessor methods below.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§validations: Vec<Result<CompilationResult, CompilationError>>

Compiled validation rules at this schema node.

§properties: HashMap<String, CompiledSchema>

Compiled child property schemas.

§items: Option<Box<CompiledSchema>>

Compiled array items schema.

§additional_properties: Option<Box<CompiledSchema>>

Compiled additionalProperties schema.

§format: SchemaFormat

The format hint from the schema (e.g., date-time, duration).

§all_of: Vec<CompiledSchema>

Compiled allOf branch schemas.

§one_of: Vec<CompiledSchema>

Compiled oneOf branch schemas.

§any_of: Vec<CompiledSchema>

Compiled anyOf branch schemas.

§max_length: Option<u64>

maxLength from the schema (for cost estimation).

§max_items: Option<u64>

maxItems from the schema (for cost estimation).

§max_properties: Option<u64>

maxProperties from the schema (for cost estimation).

§preserve_unknown_fields: bool

Whether x-kubernetes-preserve-unknown-fields: true is set on this node. When true, additionalProperties walking is skipped.

§embedded_resource: bool

Whether x-kubernetes-embedded-resource: true is set on this node. When true, apiVersion, kind, and metadata keys are injected with defaults if absent during value conversion.

Implementations§

Source§

impl CompiledSchema

Source

pub fn compilation_errors(&self) -> Vec<&CompilationError>

Returns references to all compilation errors in this node’s validations.

Source

pub fn has_errors(&self) -> bool

Returns true if any validation rule at this node failed to compile.

Trait Implementations§

Source§

impl Debug for CompiledSchema

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyExt for T
where T: Any + ?Sized,

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T> AsDebug for T
where T: Debug,

Source§

fn as_debug(&self) -> &dyn Debug

Returns self as a &dyn Debug trait object.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.