Skip to main content

Crate kinetic_doc_types

Crate kinetic_doc_types 

Source
Expand description

Shared metadata types for Kinetic’s documentation generation pipeline.

These types are referenced by:

  • The kinetic-doc-derive proc-macro (generated code uses these types)
  • The doc-gen tool (reads/writes ComponentMetadata as JSON)
  • Any crate that derives ComponentDoc

Structs§

ComponentMetadata
Metadata for a single component (source, transform, or sink).
ComponentRegistry
Collection of all component metadata for the intermediate representation.
EnumValueMetadata
Metadata for an enum variant.
EnvVarMetadata
Metadata for an environment variable.
FieldMetadata
Metadata for a single configuration field.
MetricMetadata
Metadata for a component-specific metric.
OutputFieldMetadata
Metadata for an output field (sources only).
PermissionMetadata
Metadata for a required IAM permission.
VariantMetadata
Metadata for a polymorphic enum variant (e.g., Random, Systematic in SamplingMode).

Traits§

HasEnumMetadata
Marker trait for enums to provide metadata about their variants.
HasFieldsMetadata
Trait for types that can provide metadata about their fields.
HasVariantMetadata
Trait for polymorphic enums to provide variant schema metadata.