Struct TypeRegistry 

pub struct TypeRegistry { /* private fields */ }

Re-exports of the jsonapi_core types most commonly needed to build handlers, so handler bodies can import from jsonapi_axum alone.

Deriving JsonApi still requires a direct jsonapi_core dependency: the derive macro expands to absolute ::jsonapi_core::… paths, so the crate must be nameable in the consumer’s crate. Only the runtime types are re-exported here. A registry of static type metadata for include-path validation.

Populated once at application startup via register() (using derive-generated TypeInfo) or register_info() (manual). Use validate_include_paths() to check that include paths are valid relationship traversals.

Implementations

impl TypeRegistry

pub fn new() -> TypeRegistry

Create an empty type registry.

pub fn register<T>(&mut self) -> &mut TypeRegistry

where T: ResourceObject,

Register a type using its ResourceObject::type_info() implementation.

pub fn register_info(&mut self, info: TypeInfo) -> &mut TypeRegistry

Register a TypeInfo directly.

pub fn get(&self, type_name: &str) -> Option<&TypeInfo>

Look up the TypeInfo for a type name.

pub fn validate_include_paths( &self, root_type: &str, paths: &[&str], ) -> Result<(), Error>

Validate include paths against the registered type graph.

Each path is dot-separated (e.g. "comments.author"). Walks hop-by-hop through relationship targets. Terminal hops don’t require the target type to be registered.

Trait Implementations

impl Debug for TypeRegistry

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

Formats the value using the given formatter.

impl Default for TypeRegistry

fn default() -> TypeRegistry

Returns the “default value” for a type.