Struct Runfiles

pub struct Runfiles { /* private fields */ }

An interface for accessing to Bazel runfiles.

Implementations

impl Runfiles

pub fn create() -> Result<Self>

Creates a manifest based Runfiles object when RUNFILES_MANIFEST_FILE environment variable is present, or a directory based Runfiles object otherwise.

pub fn rlocation(&self, path: impl AsRef<Path>) -> Option<PathBuf>

Returns the runtime path of a runfile.

Runfiles are data-dependencies of Bazel-built binaries and tests. The returned path may not be valid. The caller should check the path’s validity and that the path exists. @deprecated - this is not bzlmod-aware. Prefer the rlocation! macro or rlocation_from

pub fn rlocation_from( &self, path: impl AsRef<Path>, source_repo: &str, ) -> Option<PathBuf>

Returns the runtime path of a runfile.

Runfiles are data-dependencies of Bazel-built binaries and tests. The returned path may not be valid. The caller should check the path’s validity and that the path exists.

Typically this should be used via the rlocation! macro to properly set source_repo.

Trait Implementations

impl Debug for Runfiles

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

Formats the value using the given formatter.