Enum Environment

pub enum Environment {
    PublishingCrates,
    RerunCI,
    CondaBuild,
    DeveloperInWorkspace,
    UsedAsDependency,
}

Where is this build.rs build script running?

Variants

PublishingCrates

We are running cargo publish (via scripts/ci/crates.py); probably on CI.

RerunCI

We are running on CI for the Rerun workspace, but NOT publishing crates.

CondaBuild

We are running in the conda build environment.

This is a particularly special build environment because the branch checked out is from the conda feed-stock and the build happens via source downloaded from the github-hosted tgz.

See https://github.com/conda-forge/rerun-sdk-feedstock.

DeveloperInWorkspace

Are we a developer running inside the workspace of https://github.com/rerun-io/rerun ?

UsedAsDependency

We are not on Rerun’s CI, and not in the Rerun workspace.

This is most likely a Rerun user who is compiling a re_ crate because they depend on it either directly or indirectly in their Cargo.toml, or they running cargo install rerun-cli --locked or other tool that depend on a re_ crate.

In these cases we should do as little shenanigans in the build.rs as possible.

Implementations

impl Environment

pub fn detect() -> Self

Detect what environment we are running in.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl PartialEq for Environment

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Environment

impl Eq for Environment

impl StructuralPartialEq for Environment