Expand description
Core pipeline orchestration primitives.
Modules§
- cancellation
- error
- exec_
status - pipeline
- pipeline_
run_ registry - progress
- provenance
- Provenance stamping for DataPoints emitted by pipeline tasks.
- rate_
limiter - Proactive request-rate throttling for pipeline tasks.
- runtime
- sentinels
- Control-flow sentinel values that pipeline tasks return to steer the
executor. Sentinels are ordinary
Values (via the blanketimpl<T> Value for Tintask.rs), so no manual trait impl is needed. - task
- task_
context - thread_
pool
Structs§
- Async
Runtime - A wrapper around a Tokio
Runtime. - Cancellation
Handle - Allows the owner of a task to request cancellation.
- Cancellation
Token - Passed into a running task so it can observe cancellation requests.
- DbPipeline
Watcher PipelineWatcherthat writespipeline_runsrows through aPipelineRunRepository. Does not broadcastRunEvents.- Default
Pipeline RunRegistry - Concrete in-memory
PipelineRunRegistrybacked by aPipelineRunRepositoryfor durable persistence. - Dropped
Sentinel - Returned by a task to discard the current item: it is not forwarded to downstream tasks and does not appear in the pipeline output.
- Noop
Exec Status Manager - No-op implementation used when incremental loading is disabled.
- Noop
Watcher - Passthrough
Sentinel - Returned by an enriching task to forward its input unchanged.
- Pipeline
- Pipeline
Builder - A compile-time type-safe builder for
Pipeline. - Pipeline
Context - Identity of the running pipeline and the data item being processed.
- Pipeline
RunHandle - Handle to a pipeline run spawned in the background via
execute_in_background. - Pipeline
RunInfo - Identity and metadata of a pipeline run, passed to
PipelineWatcherevent methods. - Pipeline
RunResult - The successful output of a pipeline run.
- Progress
Token - A cheaply-cloneable progress token representing a portion of overall progress.
- Provenance
Context - What we know at the call site of
stamp_tree. - Rayon
Thread Pool - A
CpuPoolbacked by a dedicatedrayon::ThreadPool. - Registry
Config - Configurable bounds for the in-memory registry.
- RunEvent
- One event in a run’s lifecycle emitted on the registry channel.
- RunHandle
- Per-run handle returned by
register_*. Cheap to clone and share. - RunOutcome
- The value returned by
register_inlineonce the work future completes. - RunSpec
- Builder-style metadata for a new run.
- Scoped
RunWatcher PipelineWatcherproxy that forwards lifecycle events to a run’s slot.- Semaphore
Limiter - Admission-style concurrency limit: at most
max_per_secstarts may be issued per second. - Tagged
- A value wrapper that carries arbitrary string metadata alongside the inner value.
- Tagged
Meta - Lightweight metadata carrier that tasks can attach to any
Arc<dyn Value>when they need to propagatenode_setwithout wrapping inTagged<T>. - Task
Context - Runtime dependencies and control tokens for a single pipeline task.
- Task
Context Builder - Fluent builder for
TaskContext. - Task
Info - A
Taskbundled with optional per-task configuration. - Token
Bucket Limiter - Caps the number of starts allowed per refill window (token-bucket algorithm).
Enums§
- Core
Error - Execution
Error - Pipeline
RunStatus - High-level status of a pipeline run.
- Pipeline
Status - Registry
Error - Errors returned by registry operations.
- Retry
Delay - Delay strategy between retry attempts.
- Retry
Policy - RunEvent
Kind - Discriminant for a
RunEvent. - RunPhase
- Snapshot of a run’s high-level phase. Cheap to read; never blocks the producer.
- Task
- A single reusable unit of work in a cognee pipeline.
- Task
Call - The pending (or already-resolved) output of
Task::call. - Task
Status - Typed
Task - A typed pipeline task whose input and output types are tracked at the type level.
Traits§
- CpuPool
- Dyn-compatible interface for a CPU-bound thread pool.
- CpuPool
Ext - Ergonomic extension for
CpuPoolthat adds a genericspawnwith a return value. Auto-implemented for everyT: CpuPool. - Exec
Status Manager - Per-data-item status tracking for incremental pipeline execution.
- HasData
Point - Read / write access to the embedded
DataPointof a typed container, plus a hook to recurse into nestedDataPoint-bearing children. - Pipeline
RunRegistry - Runtime-agnostic registry for pipeline run lifecycle tracking.
- Pipeline
RunRepository - Persistence abstraction for pipeline run status rows.
- Pipeline
Watcher - Observer for pipeline and task lifecycle events.
- Rate
Limiter - Admission throttle:
acquire().awaitreturns when the caller is permitted to start an external call. Object-safe; hold asArc<dyn RateLimiter>. - Value
- Type-erased value passed between pipeline tasks.
Functions§
- cancellation_
pair - Creates a linked (
CancellationHandle,CancellationToken) pair. - downcast_
value - Attempt to downcast a
Box<dyn Value>to a concrete type. - execute
- Execute
pipelineagainst a set ofinputs. - execute_
blocking - Run
executesynchronously, blocking the calling thread until the pipeline completes. - execute_
in_ background - Spawn
executeon the current Tokio runtime and return aPipelineRunHandleimmediately. - extract_
content_ hash_ from_ value - Walk a type-erased
Valuelooking for the first non-emptyData.content_hash(raw ingestion artefact) orDataPoint.source_content_hash. Mirrors Python’s_extract_content_hash. - extract_
node_ set - Try to extract a
node_setmetadata value from anArc<dyn Value>. - extract_
node_ set_ from_ value - Walk a type-erased
Valuelooking for the first non-emptysource_node_seton an embeddedDataPoint. Mirrors Python’s_extract_node_set. - is_
dropped - Returns
trueifvalueis aDroppedSentinel. - is_
passthrough - True if
valueis aPassthroughSentinel. Seeis_droppedfor the&dyn Value(dereference-the-pointer) contract. - stamp_
tree - Stamp a tree of
HasDataPointvalues in place. - stamp_
tree_ dyn - Type-erased dispatch for
stamp_tree.
Type Aliases§
- Async
Batch Fn - Async batch task: slice of values in → one value out (via a future).
- AsyncFn
- Async task: one value in → one value out (via a future).
- Async
Stream Batch Fn - Async batch task: slice of values in → async stream of values out.
- Async
Stream Fn - Async task: one value in → async stream of values out.
- Data
IdFn - Function that extracts a stable, content-addressed identifier from a
type-erased
Value. - Pipeline
Future - A boxed, Send pipeline future whose output is a generic
Result. - Sync
Batch Fn - Sync batch task: slice of values in → one value out.
- SyncFn
- Sync task: one value in → one value out.
- Sync
Iter Batch Fn - Sync batch task: slice of values in → lazy iterator of values out.
- Sync
Iter Fn - Sync task: one value in → lazy iterator of values out.
- Task
Error - Boxed error returned by a failing task.
- Value
Iter - Boxed, type-erased iterator yielded by
SyncItertasks. - Value
Stream - Boxed, type-erased async stream yielded by
AsyncStreamtasks.