Skip to main content

Crate converge_kernel

Crate converge_kernel 

Source
Expand description

§Converge Kernel

This crate is the curated in-process execution API for Converge. Consumers embed the kernel here; they author packs in converge-pack and use converge-model for shared semantic types.

Modules§

admission
External observation admission API.
formation
Grouped offering API for self-assembling formations.

Structs§

AdmissionActor
Required actor metadata for an admission request.
AdmissionContent
Validated observation payload for admission.
AdmissionReceipt
Receipt returned after staging an admitted observation.
AdmissionRequest
Request to admit an external observation into the Converge truth pipeline.
AdmissionSource
Validated source label for admission provenance.
AgentEffect
The output of a suggestor’s execute() call.
ApprovalPointId
Identifier for an approval point or workflow reference.
ArtifactId
Unique identifier for a derived artifact.
BackendId
Identifier for a backend, provider, or adapter.
Budget
Budget limits for execution.
CandidateProvenance
Provenance information for a recall candidate.
ChainId
Identifier for a convergence chain or run.
ConstraintName
Consumer-owned name for a constraint.
ConstraintValue
Consumer-owned value for a constraint.
ContextFact
Read-only projection of a validated assertion in the context.
ContextItem
A key-value pair of context data for human review.
ContextSnapshot
Durable, verified context snapshot for storage adapters.
ContextState
The shared context for a Converge job.
ConvergeResult
Result of a converged execution.
CorrelationId
Identifier for correlating related events or runs.
Criterion
Success criterion for a frame.
CriterionId
Identifier for a success criterion.
CriterionOutcome
Evaluated outcome for a specific criterion.
Engine
The Converge execution engine.
EngineHitlPolicy
Engine-level HITL policy for gating proposals.
EventId
Identifier for an experience event envelope.
EventQuery
Query for experience events.
ExperienceEventEnvelope
Append-only event envelope.
FactContent
Content of a promoted fact.
FlowGateContext
Decision-relevant facts projected from the flow state.
FlowGateInput
Canonical input to an authorization decision for a flow gate.
FlowGatePrincipal
Principal facts projected from the flow host or application runtime.
FlowGateResource
Resource facts projected from the current flow state.
GateDecision
Human’s decision on a HITL gate request.
GateEvent
Audit trail entry for HITL gate events.
GateRequest
Request for human approval, emitted when convergence pauses at a HITL gate.
HitlPause
State returned when convergence pauses at a HITL gate.
HitlPolicy
Policy controlling when HITL approval is required.
IntegrityProof
Cryptographic integrity proof for a converged context.
LamportClock
A Lamport logical clock for causal ordering of events.
LifecycleEvent
Record of a lifecycle state change.
LocalReplayTrace
Local trace link — replay-eligible.
MerkleRoot
A Merkle tree root hash representing the integrity of a set of facts.
PackId
Identifier for a named pack.
ProposedFact
An unvalidated suggestion from a non-authoritative source.
Provenance
Uniform proposal provenance metadata.
ProviderAssignmentPayload
Typed fact payload for provider selection assignments.
ProviderRequestPayload
Typed fact payload for provider selection requests.
ProviderSelectionSuggestor
Routes required capabilities to available backends via bipartite matching.
RecallCandidate
A candidate returned by recall.
RecallPolicy
Policy controlling recall behavior.
RecallQuery
A query for semantic recall.
RemoteReplayTrace
Remote trace link — audit-eligible only.
SuggestorId
Unique identifier for a registered suggestor.
TenantId
Identifier for a tenant scope.
TextPayload
Human-readable text payload. This is explicit text, not a generic semantic escape hatch.
TimeoutPolicy
What happens when the human doesn’t respond in time.
TraceLinkId
Identifier for a stored replay trace link.
TruthId
Identifier for a truth definition.
TypesBudgets
Execution budgets.
TypesIntentId
Unique identifier for an Intent.
TypesRootIntent
Root Intent using builder pattern.
TypesRunHooks
Per-run hooks for typed intent execution.
UnitInterval
A finite value in the inclusive [0.0, 1.0] range.
UserExperienceEventEnvelope
Envelope for a UserExperienceEvent — mirrors ExperienceEventEnvelope for the user-side ledger.
ValidationError
Error when a ProposedFact fails validation.

Enums§

AdmissionActorKind
Actor class for an externally admitted observation.
AdmissionError
Error raised while constructing an admission request.
ArtifactKind
Kind of governed artifact.
AuthorityLevel
Authority level granted to a flow-gate principal.
BoundaryKind
Primitive boundary a human adjusted.
BoundaryTarget
Scope for a boundary adjustment.
BudgetResource
Budget dimension that was exhausted.
CandidateSourceType
Source type for a recall candidate.
ContextKey
Typed keys for the shared context namespace.
ConvergeError
Top-level error type for Converge operations.
CorrectionTarget
What a user correction applies to.
CriterionResult
Machine-evaluable outcome for a single criterion.
DecisionStep
A step in the multi-phase reasoning process.
ExperienceEvent
Append-only experience event payloads.
ExperienceEventKind
High-level event kinds for query filtering.
ExperienceRecord
Unified query result spanning both ledger sides.
ExperienceStoreError
Experience store error type.
FactContentKind
Kind of fact content.
FlowAction
Action being attempted against a converging flow.
FlowGateOutcome
Neutral outcome of a flow gate authorization decision.
FlowPhase
Current phase of a converging flow.
GateEventKind
Kind of gate event for audit trail.
GateVerdict
The actual approve/reject verdict.
InvariantClass
The class of an invariant determines when it’s checked and how violations are handled.
InvariantResult
The result of checking an invariant.
OverrideTarget
What a user override applies to.
RecallUse
Purpose of a recall operation.
RelevanceLevel
Relevance level for a recall candidate.
ReplayTrace
Trace link for audit and (possibly) replay.
RunResult
Result of running the engine — either converged or paused at HITL gate.
StopReason
Why execution stopped. Exhaustive enumeration for audit trails.
TimeoutAction
Action taken when HITL gate times out.
TypesIntentKind
Kind of intent (what problem class).
UserExperienceEvent
User-side experience event.

Traits§

Context
Read-only view of the shared context.
CriterionEvaluator
Application-provided boundary for evaluating success criteria.
ExperienceEventObserver
Run-scoped observer for experience events emitted during convergence.
ExperienceStore
Experience store trait (append-only ledger boundary).
FactPayload
Typed payload carried by proposed and promoted facts.
FlowGateAuthorizer
Deterministic decision provider for consequential flow actions.
Invariant
A runtime invariant that the engine enforces.
ProvenanceSource
Stable, audit-friendly identifier for an extension that emits facts into the convergence loop.
StreamingCallback
Callback trait for streaming fact emissions during convergence.
Suggestor
The core suggestor contract.

Functions§

recall_from_store
Pull recall candidates from an ExperienceStore.

Type Aliases§

ExperienceStoreResult
Result type for experience store operations.