Rust Repositories

Repository rules for defining Rust dependencies and toolchains.

Functions

• rules_rust_dependencies
• rust_analyzer_toolchain_repository
• rust_register_toolchains
• rust_repositories
• rust_repository_set
• rust_toolchain_repository

Repository Rules

• rust_toolchain_repository_proxy
• rust_toolchain_tools_repository

rules_rust_dependencies

load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies")

rules_rust_dependencies()

Dependencies used in the implementation of rules_rust.

rust_analyzer_toolchain_repository

load("@rules_rust//rust:repositories.bzl", "rust_analyzer_toolchain_repository")

rust_analyzer_toolchain_repository(name, version, exec_compatible_with, target_compatible_with,
                                   sha256s, urls, auth, netrc, auth_patterns)

Assemble a remote rust_analyzer_toolchain target based on the given params.

PARAMETERS

RETURNS

str: The name of a registerable rust_analyzer_toolchain.

rust_register_toolchains

load("@rules_rust//rust:repositories.bzl", "rust_register_toolchains")

rust_register_toolchains(dev_components, edition, allocator_library, global_allocator_library,
                         register_toolchains, rustfmt_version, rust_analyzer_version, sha256s,
                         extra_target_triples, extra_rustc_flags, extra_exec_rustc_flags, urls,
                         versions, aliases, hub_name, compact_windows_names, toolchain_triples,
                         rustfmt_toolchain_triples, extra_toolchain_infos)

Emits a default set of toolchains for Linux, MacOS, and Freebsd

Skip this macro and call the rust_repository_set macros directly if you need a compiler for other hosts or for additional target triples.

The sha256s attribute represents a dict associating tool subdirectories to sha256 hashes. As an example:

{
    "rust-1.46.0-x86_64-unknown-linux-gnu": "e3b98bc3440fe92817881933f9564389eccb396f5f431f33d48b979fa2fbdcf5",
    "rustfmt-1.4.12-x86_64-unknown-linux-gnu": "1894e76913303d66bf40885a601462844eec15fca9e76a6d13c390d7000d64b0",
    "rust-std-1.46.0-x86_64-unknown-linux-gnu": "ac04aef80423f612c0079829b504902de27a6997214eb58ab0765d02f7ec1dbc",
}

This would match for exec_triple = "x86_64-unknown-linux-gnu". If not specified, rules_rust pulls from a non-exhaustive list of known checksums..

See load_arbitrary_tool in @rules_rust//rust:repositories.bzl for more details.

PARAMETERS

rust_repositories

load("@rules_rust//rust:repositories.bzl", "rust_repositories")

rust_repositories(kwargs)

Deprecated: Use rules_rust_dependencies and rust_register_toolchains directly.

PARAMETERS

rust_repository_set

load("@rules_rust//rust:repositories.bzl", "rust_repository_set")

rust_repository_set(name, versions, exec_triple, target_settings, allocator_library,
                    global_allocator_library, extra_target_triples, rustfmt_version, edition,
                    dev_components, extra_rustc_flags, extra_exec_rustc_flags, opt_level, sha256s,
                    urls, auth, netrc, auth_patterns, register_toolchain, exec_compatible_with,
                    default_target_compatible_with, aliases, compact_windows_names)

Assembles a remote repository for the given toolchain params, produces a proxy repository to contain the toolchain declaration, and registers the toolchains.

PARAMETERS

RETURNS

dict[str, dict]: A dict of informations about all generated toolchains.

rust_toolchain_repository

load("@rules_rust//rust:repositories.bzl", "rust_toolchain_repository")

rust_toolchain_repository(name, version, exec_triple, target_triple, exec_compatible_with,
                          target_compatible_with, target_settings, channel, allocator_library,
                          global_allocator_library, rustfmt_version, edition, dev_components,
                          extra_rustc_flags, extra_exec_rustc_flags, opt_level, sha256s, urls, auth,
                          netrc, auth_patterns)

Assembles a remote repository for the given toolchain params, produces a proxy repository to contain the toolchain declaration, and registers the toolchains.

PARAMETERS

RETURNS

dict[str, str]: Information about the registerable toolchain created by this rule.

rust_toolchain_repository_proxy

load("@rules_rust//rust:repositories.bzl", "rust_toolchain_repository_proxy")

rust_toolchain_repository_proxy(name, exec_compatible_with, repo_mapping, target_compatible_with,
                                target_settings, toolchain, toolchain_type)

Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.

ATTRIBUTES

rust_toolchain_tools_repository

load("@rules_rust//rust:repositories.bzl", "rust_toolchain_tools_repository")

rust_toolchain_tools_repository(name, allocator_library, auth, auth_patterns, dev_components,
                                edition, exec_triple, extra_exec_rustc_flags, extra_rustc_flags,
                                global_allocator_library, netrc, opt_level, repo_mapping,
                                rustfmt_version, sha256s, target_triple, urls, version)

Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.

A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.

ATTRIBUTES