Incan Documentation¶
New here? Start with: Start here.
Tooling & Setup¶
How to install, configure, and use Incan Tooling.
| Document | Description |
|---|---|
| Getting Started | Installation and first steps |
| Editor Setup | IDE configuration and syntax highlighting |
| Language Server | LSP for diagnostics, hover, and go-to-definition |
| Formatting | Code formatter (incan fmt) |
| Testing | Test runner (incan test) |
Language Guide¶
How to write Incan code: Language.
| Document | Description |
|---|---|
| the Book | The Incan Book (Walks you through the Basics from a-z) |
| Error Messages | Understanding and fixing compiler errors |
| Error Handling | Result, Option, and the ? operator |
| File I/O | Reading, writing files and path handling |
| Async Programming | Async/await with Tokio |
| Derives & Traits | Derive macros and trait system |
| Scopes & Name Resolution | Block scoping, shadowing, and how names are resolved |
| Imports & Modules | Module system, imports, and built-in functions |
| Rust Interop | Using Rust crates directly from Incan |
| Web Framework | Building web apps with Axum |
Derives Reference¶
| Document | Description |
|---|---|
| String Representation | Debug and Display |
| Comparison | Eq, Ord, Hash |
| Copying & Default | Clone, Copy, Default |
| Serialization | Serialize, Deserialize |
| Custom Behavior | Overriding derived behavior |
RFCs (Request for Comments)¶
Design proposals for upcoming features are recorded in the form of RFCs.
Tip: press Esc to clear.
| RFC | Status | Track | Title |
|---|---|---|---|
| RFC 000 | Done | closed / implemented | Incan Core Language RFC (Phase 1) |
| RFC 001 | Superseded | closed / superseded | Test Fixtures |
| RFC 002 | Superseded | closed / superseded | Parametrized Tests |
| RFC 003 | Blocked | proposed / active | Frontend & WebAssembly Support |
| RFC 004 | Draft | proposed / active | Async Fixtures |
| RFC 005 | Done | closed / implemented | Rust Interop |
| RFC 006 | Planned | proposed / active | Python-Style Generators |
| RFC 007 | Superseded | closed / superseded | Inline Tests |
| RFC 008 | Done | closed / implemented | Const Bindings |
| RFC 009 | Planned | proposed / active | Sized Integer Types & Builtin Type Registry |
| RFC 010 | Draft | proposed / active | Temporary Files and Directories |
| RFC 011 | Done | closed / implemented | Precise Error Spans in F-Strings |
| RFC 012 | Planned | proposed / active | JsonValue Type, Enum Methods, and Enum Trait Adoption |
| RFC 013 | Done | closed / implemented | Rust Crate Dependencies |
| RFC 014 | Draft | proposed / active | Error Handling in Generated Rust Code |
| RFC 015 | In Progress | proposed / active | Hatch-like Tooling (Project Lifecycle CLI) |
| RFC 016 | Planned | proposed / active | loop and break <value> (Loop Expressions) |
| RFC 017 | Unknown | proposed / active | Validated newtypes with implicit coercion (pydantic-like feel) |
| RFC 018 | Planned | proposed / active | Language Primitives for Testing |
| RFC 019 | Planned | proposed / active | Test Runner, CLI, and Ecosystem |
| RFC 020 | Planned | proposed / active | Offline / Locked / Reproducible Builds (Cargo Policy + Generated Project Contract) |
| RFC 021 | Done | closed / implemented | Model field metadata and schema-safe aliases |
| RFC 022 | Done | closed / implemented | Namespaced stdlib modules and compiler→stdlib handoff |
| RFC 023 | Done | closed / implemented | Compilable Stdlib & Rust Module Binding |
| RFC 024 | Planned | proposed / active | Extensible Derive Protocol |
| RFC 025 | Unknown | proposed / active | Multi-Instantiation Trait Dispatch |
| RFC 026 | Unknown | proposed / active | User-Defined Trait Bridges |
| RFC 027 | Unknown | proposed / active | incan-vocab — Library Vocabulary Registration Crate |
| RFC 028 | Unknown | proposed / active | Trait-Based Operator Overloading |
| RFC 029 | Unknown | proposed / active | Union Types and Type Narrowing |
| RFC 030 | Unknown | proposed / active | std.collections — Extended Collection Types |
| RFC 031 | Unknown | proposed / active | Incan Library System — Phase 1 (Local Path Dependencies) |
| RFC 032 | Unknown | proposed / active | Value Enums — StrEnum and IntEnum |
| RFC 033 | Unknown | proposed / active | ctx — Typed Configuration Context |
| RFC 034 | Unknown | proposed / active | incan.pub — The Incan Package Registry |
| RFC 035 | Unknown | proposed / active | First-Class Named Function References |
| RFC 036 | Unknown | proposed / active | User-Defined Decorators |
| RFC 037 | Unknown | proposed / active | Native Web and HTTP Stdlib Redesign |
| RFC 038 | Unknown | proposed / active | Variadic Positional Args and Keyword-Argument Capture (*args / **kwargs) |
| RFC 039 | Unknown | proposed / active | race for Awaitable Concurrency |
| RFC 040 | Unknown | proposed / active | Scoped DSL Glyph Surfaces |
| RFC 041 | Unknown | proposed / active | First-Class Rust Interop Authoring |
Compiler & Contributing¶
For contributors
Architecture and compiler-internals docs are primarily for contributors. If you’re learning the language, start with the Book and the Language Guide instead of RFCs.
Docs for contributors working on the compiler and language evolution:
| Document | Description |
|---|---|
| Roadmap | Tracks implementation status and near-term planning |
| RFCs | Design proposals for upcoming features are recorded in the form of RFCs |
| Contributing | Contributor documentation landing page |
| Compiler Architecture | Compilation pipeline, module layout, and internal stages |
| Extending the Language | When to add builtins vs new syntax; end-to-end checklists |
| Contributing Index | Contributor documentation landing page |