Skip to main content

TypeDefinition

Struct TypeDefinition 

Source
pub struct TypeDefinition {
Show 19 fields pub name: String, pub description: String, pub when_to_use: String, pub boundaries: Vec<String>, pub examples: Vec<TypeExample>, pub system_message: Option<String>, pub sections: Vec<SectionDef>, pub metadata_fields: Vec<MetadataFieldDef>, pub title_weight: f32, pub text_fields: Vec<String>, pub hierarchy_relationship: String, pub edge_weight_overrides: IndexMap<String, f32>, pub propagating_relationships: Vec<String>, pub updatable_fields: Vec<String>, pub health_required_fields: Vec<String>, pub staleness_threshold_days: u32, pub write_rules: Vec<String>, pub required_outgoing: Vec<RequiredOutgoing>, pub edge_weights: IndexMap<String, f32>,
}
Expand description

Complete type definition — serde/schemars-based, authored in YAML.

Fields§

§name: String§description: String§when_to_use: String§boundaries: Vec<String>§examples: Vec<TypeExample>§system_message: Option<String>§sections: Vec<SectionDef>§metadata_fields: Vec<MetadataFieldDef>§title_weight: f32§text_fields: Vec<String>§hierarchy_relationship: String§edge_weight_overrides: IndexMap<String, f32>§propagating_relationships: Vec<String>§updatable_fields: Vec<String>§health_required_fields: Vec<String>§staleness_threshold_days: u32§write_rules: Vec<String>§required_outgoing: Vec<RequiredOutgoing>

Outgoing-edge invariants the schema asserts for this type. Each entry names a list of relationship names plus a cardinality constraint. The engine evaluates these on every memstead_create / memstead_update (post-application of inline relations: / patches) and surfaces unsatisfied blocks as a single MISSING_REQUIRED_OUTGOING warning per entity. Tier-2 (warn, never block). Empty default — types without required_outgoing keep current behaviour.

§edge_weights: IndexMap<String, f32>

Implementations§

Source§

impl TypeDefinition

Source

pub fn edge_weight(&self, rel: &str) -> f32

Look up an edge weight by relationship name. Falls back to _default when the relationship is unknown; returns 1.0 only if _default itself is missing (the loader normally guarantees it exists).

Source

pub fn section(&self, key: &str) -> Option<&SectionDef>

Source

pub fn catch_all_section(&self) -> Option<&SectionDef>

Source

pub fn metadata_field(&self, key: &str) -> Option<&MetadataFieldDef>

Source

pub fn suggest_metadata_field(&self, key: &str) -> Option<String>

Closest declared metadata-field key for a typo, used by the CRUD layer to build a “did you mean …” hint when rejecting an unknown key.

Source

pub fn suggest_section(&self, key: &str) -> Option<String>

Closest declared section key for a typo. Used by the CRUD layer to build the UNKNOWN_SECTION envelope’s suggestion field on inbound create/update writes.

Source

pub fn required_sections(&self) -> impl Iterator<Item = &SectionDef>

Required sections in declaration order.

Source

pub fn optional_sections(&self) -> impl Iterator<Item = &SectionDef>

Optional sections in declaration order.

Source

pub fn system_message_str(&self) -> &str

System message as a string — empty if unset.

Trait Implementations§

Source§

impl Clone for TypeDefinition

Source§

fn clone(&self) -> TypeDefinition

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 TypeDefinition

Source§

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

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

impl<'de> Deserialize<'de> for TypeDefinition

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 JsonSchema for TypeDefinition

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for TypeDefinition

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.