Struct WhereFieldSchema 

pub struct WhereFieldSchema { /* private fields */ }

The where keys a type declares, alongside their casts.

Why this is not just FieldTypeMap

FieldTypeMap cannot distinguish “this type has no fields” from “this type was not found” — both produce an empty map, and the generator reads empty as “no type information, skip the casts”. Reusing it as an allowlist would therefore fail open on a missing type, or — if inverted — fail closed on every schema with no field metadata.

So the “cannot adjudicate” state is a distinct value here (known: None) rather than a property of an empty collection. Every consumer has to name that branch explicitly.

Implementations

impl WhereFieldSchema

pub fn casts_only(casts: Arc<FieldTypeMap>) -> WhereFieldSchema

A schema that cannot adjudicate field names: casts only, no allowlist.

This is the honest constructor for a caller that has type information but no type definition — fuzzers, benchmarks, and the wire path.

pub fn with_known_keys( casts: Arc<FieldTypeMap>, known: HashMap<String, WhereFieldInfo>, ) -> WhereFieldSchema

A schema that can adjudicate its top level and nothing below it.

For callers that know the entry type’s keys but cannot name what a relation points at. See with_relations for the compiled-schema path.

pub fn with_relations( casts: Arc<FieldTypeMap>, known: HashMap<String, WhereFieldInfo>, relations: Arc<HashMap<String, Arc<HashMap<String, WhereFieldInfo>>>>, ) -> WhereFieldSchema

A schema that can adjudicate every level a nested predicate reaches.

relations maps a declared type name to that type’s where keys, so a key at depth n is scored against the type the path actually arrived at rather than passed through unchecked.

pub const fn casts(&self) -> &Arc<FieldTypeMap>

The declared casts.

pub fn lookup(&self, snake_key: &str) -> Option<&WhereFieldInfo>

What the schema knows about snake_key, or None when it cannot adjudicate or the key is undeclared — use Self::can_adjudicate to tell those apart.

pub const fn can_adjudicate(&self) -> bool

Whether the schema carries enough information to reject an unknown key.

pub fn declared_names(&self) -> Vec<&str>

Declared names, for “did you mean” hints.

pub fn root_level(&self) -> Option<&HashMap<String, WhereFieldInfo>>

The entry level a where object is parsed against.

pub fn level_of( &self, type_name: &str, ) -> Option<&HashMap<String, WhereFieldInfo>>

The level a nested predicate on a field of type type_name descends into, or None when this schema carries no keys for it.

Trait Implementations

impl Clone for WhereFieldSchema

fn clone(&self) -> WhereFieldSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WhereFieldSchema

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

Formats the value using the given formatter.

impl Default for WhereFieldSchema

fn default() -> WhereFieldSchema

Returns the “default value” for a type.