Struct BaseModkitPluginV1 

pub struct BaseModkitPluginV1<P: GtsSchema + GtsSchema> {
    pub id: GtsInstanceId,
    pub vendor: String,
    pub priority: i16,
    pub properties: P,
}

Fields

id: GtsInstanceId

vendor: String

priority: i16

properties: P

Implementations

impl<P> BaseModkitPluginV1<P>

where P: GtsSchema + JsonSchema + GtsSchema,

pub fn gts_schema_id() -> &'static GtsSchemaId

Get the GTS schema identifier as a static reference.

pub fn gts_base_schema_id() -> Option<&'static GtsSchemaId>

Get the parent (base) schema identifier as a static reference. Returns None for base structs (those with base = true).

pub fn gts_make_instance_id(segment: &str) -> GtsInstanceId

Generate a GTS instance ID by appending a segment to the schema ID.

impl<P> BaseModkitPluginV1<P>

where P: GtsSchema + JsonSchema + GtsSchema,

pub fn gts_schema_with_refs_as_string() -> String

Get the JSON Schema with allOf + $ref for inheritance as a JSON string.

pub fn gts_schema_with_refs_as_string_pretty() -> String

Get the JSON Schema with allOf + $ref for inheritance as a pretty-printed JSON string.

impl<P> BaseModkitPluginV1<P>

where P: Serialize + GtsSchema + GtsSchema,

pub fn gts_instance_json(&self) -> Value

Serialize this instance to a serde_json::Value.

pub fn gts_instance_json_as_string(&self) -> String

Serialize this instance to a JSON string.

pub fn gts_instance_json_as_string_pretty(&self) -> String

Serialize this instance to a pretty-printed JSON string.

Trait Implementations

impl<P: Debug + GtsSchema> Debug for BaseModkitPluginV1<P>

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for BaseModkitPluginV1<P>

where P: Deserialize<'de> + GtsSchema + GtsSchema,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P> GtsSchema for BaseModkitPluginV1<P>

where P: GtsSchema + JsonSchema + GtsSchema,

const SCHEMA_ID: &'static str = "gts.x.core.modkit.plugin.v1~"

The GTS schema ID for this type.

const GENERIC_FIELD: Option<&'static str>

The name of the field that contains the generic type parameter, if any. For example, BaseEventV1<P> has payload as the generic field.

fn gts_schema_with_refs() -> Value

Returns the JSON schema for this type with $ref references intact.

fn gts_schema() -> Value

Returns the composed JSON schema for this type. For types with generic parameters that implement GtsSchema, this returns the schema with the generic field’s type replaced by the nested type’s schema.

fn innermost_schema_id() -> &'static str

Get the innermost schema ID in a nested generic chain. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns PlaceOrderDataV1’s ID.

fn innermost_schema() -> Value

Get the innermost (leaf) type’s raw schema. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns PlaceOrderDataV1’s schema.

fn collect_nesting_path() -> Vec<&'static str>

Collect the nesting path (generic field names) from outer to inner types. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns ["payload", "data"].

fn gts_schema_with_refs_allof() -> Value

Generate a GTS-style schema with allOf and $ref to base type.

fn wrap_in_nesting_path( path: &[&str], properties: Value, required: Value, generic_field: Option<&str>, ) -> Value

Wrap properties in a nested structure following the nesting path. For path ["payload", "data"] and properties {order_id, product_id, last}, returns { "payload": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "properties": {...}, "required": [...] } } } }

impl<P: GtsSchema + GtsSchema + JsonSchema> JsonSchema for BaseModkitPluginV1<P>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<P> Serialize for BaseModkitPluginV1<P>

where P: Serialize + GtsSchema + GtsSchema,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.