Skip to main content

ComponentDataModel

Struct ComponentDataModel 

Source
#[repr(C)]
pub struct ComponentDataModel { pub name: AzString, pub description: AzString, pub fields: ComponentDataFieldVec, }
Expand description

A named data model (struct definition) for code generation.

Stored in ComponentLibrary::data_models. Components reference these by name in ComponentDataField::field_type, enabling nested/structured data models. For example, a UserCard component might have a field user: UserProfile where UserProfile is a ComponentDataModel.

Fields§

§name: AzString

Type name, e.g. “UserProfile”, “TodoItem

§description: AzString

Human-readable description

§fields: ComponentDataFieldVec

Fields in this struct

Implementations§

Source§

impl ComponentDataModel

Source

pub fn get_field(&self, name: &str) -> Option<&ComponentDataField>

Look up a field by name.

Source

pub fn get_default_string(&self, name: &str) -> Option<&AzString>

Look up a field’s default value as a string, if it exists and is a String variant.

Source

pub fn with_default(self, name: &str, value: ComponentDefaultValue) -> Self

Clone this data model, overriding the default value for a field by name. If the field is not found, the data model is returned unchanged.

Source§

impl ComponentDataModel

Source

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

Serialize this data model to a JSON string.

§Errors

Returns the serializer’s error message if the model cannot be represented as JSON.

Source

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

Deserialize a data model from a JSON string.

§Errors

Returns the parser’s error message if json is malformed or does not match the data-model shape.

Trait Implementations§

Source§

impl Clone for ComponentDataModel

Source§

fn clone(&self) -> ComponentDataModel

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 Debug for ComponentDataModel

Source§

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

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

impl<'de> Deserialize<'de> for ComponentDataModel

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

A data model is a JSON object. This deliberately drives the deserializer with deserialize_map instead of deserialize_struct: the struct hint makes serde accept a sequence as well (the positional encoding used by compact formats), so from_json("[]") used to succeed and hand back a nameless, field-less model instead of reporting that the input is not a data model at all. Every key stays optional, so {} still deserializes to the empty model.

Source§

impl Extend<ComponentDataModel> for ComponentDataModelVec

Source§

fn extend<T: IntoIterator<Item = ComponentDataModel>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl FromIterator<ComponentDataModel> for ComponentDataModelVec

Source§

fn from_iter<T>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl Serialize for ComponentDataModel

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

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.