Skip to content
Recoco Docs

API Documentation

Recoco provides detailed API documentation generated from source code comments. docs.rs hosts the documentation and covers all public APIs, traits, and types.

Main Crate Documentation

Section titled “Main Crate Documentation”

Recoco Core

Section titled “Recoco Core”

The main recoco crate contains the core functionality:

docs.rs/recoco - Complete API reference for the core library

Includes:

  • FlowBuilder - Construct data flows
  • execution module - Runtime evaluation
  • ops module - Operations (sources, functions, targets)
  • schema module - Type system
  • value module - Data values
  • prelude - Common imports

Utility Crates

Section titled “Utility Crates”

Recoco Utils

Section titled “Recoco Utils”

Helper utilities and shared functionality:

docs.rs/recoco-utils - Utility functions and types

Recoco Splitters

Section titled “Recoco Splitters”

Text splitting and parsing with Tree-sitter:

docs.rs/recoco-splitters - Syntax-aware text splitting

Section titled “Quick Links”

Usage

Section titled “Usage”

To use Recoco in your project:

[dependencies]
recoco = "0.2"

See the Getting Started guide for a complete walkthrough.

Features Documentation

Section titled “Features Documentation”

Each feature is documented in the API docs with examples:

  • Sources: source-local-file, source-postgres, source-s3, source-azure, source-gdrive
  • Targets: target-postgres, target-qdrant, target-neo4j, target-kuzu
  • Functions: function-split, function-embed, function-extract-llm, function-detect-lang, function-json

Check the Core Crate reference for a complete list of features.