Skip to main content

ResourceSpec

Struct ResourceSpec 

Source
pub struct ResourceSpec {
    pub resource: ResourceMeta,
    pub crud: CrudMapping,
    pub action: Option<ActionMapping>,
    pub identity: IdentityConfig,
    pub fields: BTreeMap<String, FieldOverride>,
    pub read_mapping: BTreeMap<String, String>,
}
Expand description

Top-level resource specification loaded from TOML.

Two flavours are supported:

  • CRUD (default): kind = "crud" or absent — requires [crud] + [identity] tables. Resolved via crate::resolve_resource.
  • Action (RPC-style): kind = "action" — requires [action] table; MUST NOT have [crud]/[identity]. Resolved via crate::resolve_action.

Both crud and identity default to empty placeholders so an action TOML can omit them entirely. Use ResourceSpec::is_action before dispatching to the CRUD resolver — calling resolve_resource on an action spec will fail loudly.

Fields§

§resource: ResourceMeta

Resource metadata (name, description, category, kind).

§crud: CrudMapping

CRUD operation mappings.

Defaults to an empty placeholder so kind = "action" specs (which have no [crud] table) parse cleanly. CRUD callers must verify via ResourceSpec::is_action before reading the empty struct.

§action: Option<ActionMapping>

Action mapping for RPC-style endpoints. Required when kind = "action".

§identity: IdentityConfig

Identity and import configuration.

Defaults to an empty placeholder so action specs parse without an [identity] table.

§fields: BTreeMap<String, FieldOverride>

Per-field overrides (skip, computed, sensitive, etc.).

§read_mapping: BTreeMap<String, String>

Mapping from API response JSON paths to field names.

Implementations§

Source§

impl ResourceSpec

Source

pub fn is_action(&self) -> bool

Whether this spec describes an action (RPC-style) resource.

Action specs MUST have kind = "action" AND a populated [action] table. CRUD specs (kind absent or "crud") return false.

Source§

impl ResourceSpec

Source

pub fn load(path: &Path) -> Result<Self, IacForgeError>

Load a resource spec from a TOML file.

Delegates to ConfigLoader::load.

§Errors

Returns an error if the file can’t be read or parsed.

Source

pub fn validate(&self, api: &Spec) -> Result<(), IacForgeError>

Validate the resource spec against an OpenAPI spec.

Dispatches on ResourceSpec::is_action:

  • CRUD specs validate create/read/delete (+ optional update / read response) schemas and the create endpoint path.
  • Action specs validate the action endpoint + request schema (and the optional response schema).
§Errors

Returns validation errors if schemas are missing or endpoints don’t exist.

Trait Implementations§

Source§

impl Clone for ResourceSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConfigLoader for ResourceSpec

Source§

fn load(path: &Path) -> Result<Self, IacForgeError>

Load from a TOML file. Read more
Source§

fn from_toml(content: &str) -> Result<Self, IacForgeError>

Parse from a TOML string (useful for tests). Read more
Source§

impl Debug for ResourceSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ResourceSpec

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.