Struct rustwide::toolchain::Toolchain

pub struct Toolchain { /* private fields */ }

Representation of a Rust compiler toolchain.

The Toolchain struct represents a compiler toolchain, either downloaded from rustup or from the rust-lang/rust repo’s CI artifacts storage, and it provides the methods to install and use it.

Implementations

impl Toolchain

pub fn is_needed_by_rustwide(&self) -> bool

Returns whether or not this toolchain is needed by rustwide itself.

This toolchain is used for doing things like installing tools.

let tc = Toolchain::dist("stable-x86_64-unknown-linux-gnu");
assert!(tc.is_needed_by_rustwide());
let tc = Toolchain::dist("nightly-x86_64-unknown-linux-gnu");
assert!(!tc.is_needed_by_rustwide());

pub fn dist(name: &str) -> Self

Create a new dist toolchain.

Dist toolchains are all the toolchains available through rustup and distributed from static.rust-lang.org. You need to provide the toolchain name (the same you’d use to install that toolchain with rustup).

pub fn ci(sha: &str, alt: bool) -> Self

Available on crate feature unstable-toolchain-ci only.

Create a new CI toolchain.

CI toolchains are artifacts built for every merged PR in the rust-lang/rust repository, identified by the SHA of the merge commit. These builds are purged after a couple of months, and are available both in normal mode and “alternate” mode (experimental builds with extra debugging and testing features enabled).

There is no availability or stability guarantee for these builds!

pub fn as_dist(&self) -> Option<&DistToolchain>

If this toolchain is a dist toolchain, return its metadata.

pub fn as_ci(&self) -> Option<&CiToolchain>

Available on crate feature unstable-toolchain-ci only.

If this toolchain is a CI toolchain, return its metadata.

pub fn install(&self, workspace: &Workspace) -> Result<(), Error>

Download and install the toolchain.

pub fn add_component(
    &self,
    workspace: &Workspace,
    name: &str
) -> Result<(), Error>

Download and install a component for the toolchain.

pub fn remove_component(
    &self,
    workspace: &Workspace,
    name: &str
) -> Result<(), Error>

Remove a component already installed for the toolchain.

pub fn add_target(&self, workspace: &Workspace, name: &str) -> Result<(), Error>

Download and install a target for the toolchain.

If the toolchain is not installed in the workspace an error will be returned. This is only supported for dist toolchains.

pub fn remove_target(
    &self,
    workspace: &Workspace,
    name: &str
) -> Result<(), Error>

Remove a target already installed for the toolchain.

If the toolchain is not installed in the workspace or the target is missing an error will be returned. This is only supported for dist toolchains.

pub fn installed_targets(
    &self,
    workspace: &Workspace
) -> Result<Vec<String>, Error>

Return a list of installed targets for this toolchain.

If the toolchain is not installed an empty list is returned.

pub fn uninstall(&self, workspace: &Workspace) -> Result<(), Error>

Remove the toolchain from the rustwide workspace, freeing up disk space.

pub fn cargo(&self) -> impl Runnable + '_

Return a runnable object configured to run cargo with this toolchain. This method is intended to be used with rustwide::cmd::Command.

Example

let toolchain = Toolchain::dist("beta");
Command::new(&workspace, toolchain.cargo())
    .args(&["check"])
    .run()?;

pub fn rustc(&self) -> impl Runnable + '_

Return a runnable object configured to run rustc with this toolchain. This method is intended to be used with rustwide::cmd::Command.

Example

let toolchain = Toolchain::dist("beta");
Command::new(&workspace, toolchain.rustc())
    .args(&["hello.rs"])
    .run()?;

pub fn rustup_binary(&self, name: &'static str) -> impl Runnable + '_

Return a runnable object configured to run name with this toolchain. This method is intended to be used with rustwide::cmd::Command.

Example

let toolchain = Toolchain::dist("beta");
Command::new(&workspace, toolchain.rustup_binary("rustdoc"))
    .args(&["hello.rs"])
    .run()?;

Trait Implementations

impl Clone for Toolchain

fn clone(&self) -> Toolchain

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Toolchain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Toolchain

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Toolchain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Toolchain

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Toolchain> for Toolchain

fn eq(&self, other: &Toolchain) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Toolchain) -> bool

This method tests for !=.

impl Serialize for Toolchain

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Toolchain

impl StructuralEq for Toolchain

impl StructuralPartialEq for Toolchain