Crate shaperail_core 

shaperail-core

Shared foundation types for the Shaperail framework.

This crate defines the core data structures that all other Shaperail crates consume: resource definitions, field types, endpoint specs, error handling, and project configuration.

Structs

AuthConfig

Authentication configuration.

CacheConfig

Redis cache configuration.

CacheSpec

Cache configuration for an endpoint.

ChannelDefinition

Definition of a WebSocket channel, parsed from a .channel.yaml file.

ChannelHooks

Lifecycle hooks for a WebSocket channel.

DatabaseConfig

Database connection configuration.

EndpointSpec

Specification for a single endpoint in a resource.

EventSubscriber

An event subscriber routes events to targets.

EventsConfig

Events and webhooks configuration.

FieldError

A single field-level validation error.

FieldSchema

Definition of a single field in a resource schema.

InboundWebhookConfig

Inbound webhook endpoint configuration.

IndexSpec

Specification for a database index.

LoggingConfig

Logging and observability configuration.

ProjectConfig

Project-level configuration, parsed from shaperail.config.yaml.

RelationSpec

Specification for a relationship to another resource.

ResourceDefinition

Complete definition of a Shaperail resource, parsed from a resource YAML file.

StorageConfig

Object storage configuration.

UploadSpec

File upload configuration for an endpoint.

WebhookConfig

Global outbound webhook settings.

Enums

AuthRule

Authentication rule for an endpoint.

EventTarget

A target for event dispatch.

FieldType

All supported field types in a Shaperail resource schema.

HttpMethod

HTTP method for an endpoint.

PaginationStyle

Pagination strategy for list endpoints.

RelationType

Type of relationship between two resources.

ShaperailError

Unified error type used across all Shaperail crates.

WorkerCount

Worker thread count: either automatic or a fixed number.

WsClientMessage

Client-to-server WebSocket message format.

WsServerMessage

Server-to-client WebSocket message format.