Struct ResourceSpec 

pub struct ResourceSpec {
    pub kind: String,
    pub name: String,
    pub route: String,
    pub storage: StorageSpec,
    pub indexes: Vec<IndexSpec>,
    pub uniques: Vec<UniqueSpec>,
    pub relations: Vec<RelationSpec>,
    pub api: ApiSpec,
    pub policy: PolicySpec,
    pub validate: ValidateSpec,
    pub examples: HashMap<String, Value>,
    pub events: EventSpec,
}

Resource specification for code generation and API definition

Fields

kind: String

name: String

route: String

storage: StorageSpec

indexes: Vec<IndexSpec>

uniques: Vec<UniqueSpec>

relations: Vec<RelationSpec>

api: ApiSpec

policy: PolicySpec

validate: ValidateSpec

examples: HashMap<String, Value>

events: EventSpec

Implementations

impl ResourceSpec

pub fn from_yaml(yaml: &str) -> Result<Self, Error>

Create a resource spec from YAML string

pub fn to_yaml(&self) -> Result<String, Error>

Convert resource spec to YAML string

pub fn from_json(json: &str) -> Result<Self, Error>

Create a resource spec from JSON string

pub fn to_json(&self) -> Result<String, Error>

Convert resource spec to JSON string

pub fn table_name(&self) -> &str

Get the table name for this resource

pub fn primary_key(&self) -> Option<&FieldSpec>

Get the primary key field specification

pub fn required_fields(&self) -> Vec<&FieldSpec>

Get all required fields

pub fn indexed_fields(&self) -> Vec<&FieldSpec>

Get all indexed fields

pub fn has_soft_delete(&self) -> bool

Check if resource has soft delete enabled

pub fn has_timestamps(&self) -> bool

Check if resource has timestamps enabled

Trait Implementations

impl Clone for ResourceSpec

fn clone(&self) -> ResourceSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResourceSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.