Crate cargo_dist_schema

cargo-dist-schema

This crate exists to serialize and deserialize the dist-manifest.json produced by dist. Ideally it should be reasonably forward and backward compatible with different versions of this format.

The root type of the schema is DistManifest.

Modules

• macros
  Internal macros for cargo-dist

Macros

• declare_strongly_typed_string
  Motivation

Structs

• Artifact
  A distributable artifact that’s part of a Release
• Asset
  An asset contained in an artifact (executable, license, etc.)
• AssetInfo
  Info about an Asset (binary)
• CiInfo
  CI backend info
• DistManifest
  A report of the releases and artifacts that dist generated
• DynamicLibraryAsset
  A C dynamic library artifact (so/dylib/dll)
• EnvironmentVariables
  Release-specific environment variables
• ExecutableAsset
  An executable artifact (exe/binary)
• GithubCiInfo
  Github CI backend
• GithubHosting
  Github Hosting
• GithubMatrix
  Github CI Matrix
• GithubMatrixEntry
  Entry for a github matrix
• GithubRunner
  The name of a Github Actions Runner, like ubuntu-20.04 or macos-13
• GithubRunnerRef
  The name of a Github Actions Runner, like ubuntu-20.04 or macos-13
• GlibcVersion
  Minimum glibc version required to run software
• Hosting
  Possible hosting providers
• Library
  Represents a dynamic library located somewhere on the system
• Linkage
  Information about dynamic libraries used by a binary
• Release
  A Release of an Application
• StaticLibraryAsset
  A C static library artifact (a/lib)
• SystemInfo
  Info about a system used to build this announcement.
• TargetTriple
  A rust target-triple (e.g. “x86_64-pc-windows-msvc”)
• TargetTripleRef
  A rust target-triple (e.g. “x86_64-pc-windows-msvc”)
• VersionInfo
  Info about a manifest version

Enums

• ArtifactKind
  A kind of Artifact
• AssetKind
  An artifact included in a Distributable
• BuildEnvironment
  Information about the build environment on this system
• Format
  More coarse-grained version info, indicating periods when significant changes were made
• PackageManager
  Represents the package manager a library was installed by
• PrRunMode
  Type of job to run on pull request

Constants

• DIST_EPOCH_1_MAX
  The first epoch of cargo-dist, after this version a bunch of things changed and we don’t support that design anymore!
• DIST_EPOCH_2_MAX
  Second epoch of cargo-dist, after this we stopped putting versions in artifact ids. This changes the download URL, but everything else works the same.
• SELF_VERSION
  The current version of cargo-dist-schema

Functions

• check_version
  Take serialized json and minimally parse out version info
• format_of_version
  Get the format for a given version

Type Aliases

• ArtifactId
  The unique ID of an Artifact
• AssetId
  The unique ID of an Asset
• LocalPath
  A local system path on the machine dist was run.
• RelPath
  A relative path inside an artifact
• SortedSet
  A sorted set of values
• SystemId
  The unique ID of a System