Rust API

Xvc is built as a set of Rust crates that can be used as libraries, not just through the xvc command line. Each crate is published to crates.io and documented on docs.rs.

The pages in this section link to the generated API documentation for each crate:

  • xvc — the top-level library and binary entry point
  • xvc-config — cascading configuration
  • xvc-core — core types and utilities shared across crates
  • xvc-ecs — the entity-component system and its stores
  • xvc-file — file tracking and management
  • xvc-logging — output channel and logging macros
  • xvc-pipeline — pipeline definition and execution
  • xvc-storage — storage backends
  • xvc-walker — the ignore-aware filesystem walker

For the design behind these crates, see the Architecture chapter.