RustQ.Cargo (rustq v0.6.0)

Helpers for discovering Rust package metadata through Cargo.

This module wraps cargo metadata so generators can find source roots for registry, git, and path dependencies without assuming Cargo's on-disk cache layout.

Summary

Functions

metadata!(opts \\ [])

Returns decoded cargo metadata for a manifest.

package!(package_name, opts \\ [])

Returns package metadata by name.

package_source!(package_name, opts \\ [])

Returns the source root for a package by name.

package_sources!(opts \\ [])

Returns all package source roots from Cargo metadata.

source_link(package, source_path, line)

Returns a web source link for a package source path and line.

source_link(package_name, source_path, line, opts \\ [])

Returns a web source link for a package by name, path, and line.

Functions

metadata!(opts \\ [])

@spec metadata!(keyword()) :: RustQ.Cargo.Metadata.t()

Returns decoded cargo metadata for a manifest.

Options:

:manifest_path - path to Cargo.toml. Defaults to "Cargo.toml".

package!(package_name, opts \\ [])

@spec package!(
  String.t(),
  keyword()
) :: RustQ.Cargo.Package.t()

Returns package metadata by name.

Raises if the package is not present in cargo metadata output.

package_source!(package_name, opts \\ [])

@spec package_source!(
  String.t(),
  keyword()
) :: Path.t()

Returns the source root for a package by name.

Raises if the package is not present in cargo metadata output.

package_sources!(opts \\ [])

@spec package_sources!(keyword()) :: %{required(String.t()) => Path.t()}

Returns all package source roots from Cargo metadata.

The returned map keys are package names and values are source directories derived from each package's manifest_path.

source_link(package, source_path, line)

@spec source_link(RustQ.Cargo.Package.t(), Path.t(), pos_integer()) ::
  String.t() | nil

Returns a web source link for a package source path and line.

Registry packages currently link to docs.rs source pages. Path packages or paths outside the package root return nil.

source_link(package_name, source_path, line, opts \\ [])

@spec source_link(String.t(), Path.t(), pos_integer(), keyword()) :: String.t() | nil

Returns a web source link for a package by name, path, and line.