Module deps

Atom Dependency Handling

This module provides the core types for working with an Atom manifest’s dependencies. It defines the structure for specifying different types of dependencies in an atom’s manifest file, including atom references, direct pins, and build-time sources.

Dependency Types

The manifest supports three main categories of dependencies:

• Atom dependencies - References to other atoms by ID and version
• Pin dependencies - Direct references to external sources (URLs, Git repos, tarballs)
• Source dependencies - Build-time dependencies like source code or config files

Key Types

• Dependency - The main dependency structure containing all dependency types
• AtomReq - Requirements for atom dependencies
• PinReq - Requirements for pinned dependencies
• SrcReq - Requirements for build-time sources
• PinType - Enum distinguishing between direct and indirect pins

Example Usage

[deps.atoms]
# Reference to another atom
other-atom = { version = "^1.0.0", path = "../other-atom" }

[deps.pins]
# pin to external evaluation time source code
external-lib = { url = "https://example.com/lib.tar.gz" }

# Git pin
git-dep = { url = "https://github.com/user/repo.git", ref = "main" }

# Indirect pin (from another atom)
shared-lib = { from = "other-atom", get = "lib" }

[deps.srcs]
# Build-time source
src-code = { url = "https://registry.example.com/code.tar.gz" }

Validation

All dependency types use #[serde(deny_unknown_fields)] to ensure strict validation and prevent typos in manifest files. Optional fields are properly handled with skip_serializing_if to keep the TOML output clean.

Structs

AtomReq

Represents a locked atom dependency, referencing a verifiable repository slice.

GitPin

Represents a direct git pin to an external source.

IndirectPin

Represents an indirect pin referencing a dependency from another atom.

ManifestWriter

A Writer struct to ensure modifications to the manifest and lock stay in sync

Pin

Represents a simple pin, with an optional unpack field.

PinReq

Represents a direct pin to an external source, such as a URL or tarball.

SrcReq

Represents a dependency which is fetched at build time as an FOD.

Enums

Dependency

The dependencies specified in the manifest

DirectPin

Represents the two types of direct pins.

DocError

transparent errors for TypedDocument

GitStrat

Represents the two types of git fetch strategies.

PinType

Represents the different types of pins for dependencies.