Struct CommonModel 

pub struct CommonModel {
    pub id: Id,
    pub name: String,
    pub fields: Vec<Field>,
    pub sample: Value,
    pub primary: bool,
    pub category: String,
    pub interface: HashMap<Lang, String>,
    pub record_metadata: RecordMetadata,
}

Fields

id: Id

name: String

fields: Vec<Field>

sample: Value

primary: bool

category: String

interface: HashMap<Lang, String>

record_metadata: RecordMetadata

Implementations

impl CommonModel

pub fn new( name: String, version: Version, fields: Vec<Field>, category: String, sample: Value, primary: bool, interface: HashMap<Lang, String>, ) -> Self

pub fn new_empty() -> Self

pub fn reference(&self) -> Schema

pub fn generate_as(&self, lang: &Lang) -> String

Generates the model as a string in the specified language without recursively expanding inner models and enums. Simply provides a reference to the inner model or enum.

Arguments

• lang - The language to generate the model in

pub async fn generate_as_expanded<'a>( &self, lang: &Lang, cm_store: &MongoStore<CommonModel>, ce_store: &MongoStore<CommonEnum>, strategy: TypeGenerationStrategy<'a>, ) -> String

Generates the model as a string in the specified language with recursively expanded inner models and enums. This is useful for generating the entire model and its dependencies in a single file.

Arguments

• lang - The language to generate the model in
• cm_store - The store for common models
• ce_store - The store for common enums
• strategy - The strategy to use for generating the type

pub async fn as_typescript_schema_expanded( &self, cm_store: &MongoStore<CommonModel>, ce_store: &MongoStore<CommonEnum>, type: SchemaType, ) -> String

pub fn request_body(&self, required: bool) -> RequestBody

pub fn get_expandable_fields(&self) -> Vec<Field>

pub fn get_primitive_fields(&self) -> Vec<Field>

pub fn get_enum_references(&self) -> Vec<Field>

pub fn get_enum_fields(&self) -> Vec<Field>

pub fn flatten(self) -> Vec<CommonModel>

pub async fn expand_all( &self, cm_store: MongoStore<CommonModel>, ce_store: MongoStore<CommonEnum>, ) -> Result<Self, IntegrationOSError>

pub async fn fetch_all_enum_references( &self, cm_store: MongoStore<CommonModel>, ce_store: MongoStore<CommonEnum>, ) -> Result<Vec<CommonEnum>, IntegrationOSError>

Fetches all the enum references and non-enum references of the current model and its children

Arguments

• cm_store - The store to fetch the common models from
• ce_store - The store to fetch the common enums from

Returns

A vector of all the enum references and flat enums that are not common

pub async fn fetch_all_children_common_models( &self, store: MongoStore<CommonModel>, ) -> Result<(HashMap<String, CommonModel>, HashSet<String>), IntegrationOSError>

Fetches all the children of the current model and returns two values:

• A map of the children models with their names as keys
• A set of the names of the children models that were not found

pub async fn get_all_common_models( store: MongoStore<CommonModel>, ) -> Result<Vec<String>, IntegrationOSError>

pub fn to_flat_json(&self) -> Value

Trait Implementations

impl Clone for CommonModel

fn clone(&self) -> CommonModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonModel

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

Formats the value using the given formatter.

impl Default for CommonModel

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommonModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UnsavedCommonModel> for CommonModel

fn from(model: UnsavedCommonModel) -> Self

Converts to this type from the input type.

impl Hash for CommonModel

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CommonModel

fn eq(&self, other: &CommonModel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommonModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CommonModel> for JsonSchema

type Error = IntegrationOSError

The type returned in the event of a conversion error.

fn try_from(common_model: CommonModel) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CommonModel

impl StructuralPartialEq for CommonModel