Struct ObjectSchema 

pub struct ObjectSchema {
    pub fields: Vec<FieldDef>,
}

Schema for an object with known fields.

Field names are fuzzy-repaired against the defined names; field values are repaired according to each field’s FieldKind. Because FieldKind can contain nested ObjectSchemas, repair recurses to any depth.

Example

use fuzzy_parser::{FieldKind, ObjectSchema};

let schema = ObjectSchema::new(["name"])
    .with_field_kind("timeout", FieldKind::Integer)
    .with_field_kind("derives", FieldKind::enum_array(["Debug", "Clone"]))
    .with_field_kind(
        "inner",
        FieldKind::Object(ObjectSchema::new(["host", "port"])),
    );

Fields

fields: Vec<FieldDef>

The defined fields.

Implementations

impl ObjectSchema

pub fn from_json_schema( root: &Value, ) -> Result<SchemaImport<ObjectSchema>, FuzzyError>

Convert a JSON Schema document for a plain (non-enum) object into an ObjectSchema.

Example

use fuzzy_parser::{FieldKind, ObjectSchema};
use serde_json::json;

let json_schema = json!({
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "timeout": {"type": "integer"}
    }
});

let import = ObjectSchema::from_json_schema(&json_schema).unwrap();
assert_eq!(import.schema.kind_of("timeout"), Some(&FieldKind::Integer));

impl ObjectSchema

pub fn new<I, S>(valid_fields: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Create a schema from field names (all fields accept any value shape).

pub fn empty() -> Self

Create an empty schema (add fields with the builder methods).

pub fn with_field(self, name: impl AsRef<str>) -> Self

Add a field that accepts any value shape.

pub fn with_field_kind(self, name: impl AsRef<str>, kind: FieldKind) -> Self

Add a field with an expected value shape.

If a field with the same name already exists, its kind is replaced.

pub fn is_valid_field(&self, field: &str) -> bool

Check if a field name is valid.

pub fn field_names(&self) -> impl Iterator<Item = &str>

Iterate over the defined field names.

pub fn kind_of(&self, field: &str) -> Option<&FieldKind>

Get the expected value shape for a field, if defined.

Trait Implementations

impl Clone for ObjectSchema

fn clone(&self) -> ObjectSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectSchema

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

Formats the value using the given formatter.

impl Default for ObjectSchema

fn default() -> ObjectSchema

Returns the “default value” for a type.

impl PartialEq for ObjectSchema

fn eq(&self, other: &ObjectSchema) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ObjectSchema