Skip to main content

BuildInfo

Struct BuildInfo 

Source
#[non_exhaustive]
pub struct BuildInfo { pub name: &'static str, pub version: &'static str, pub commit: &'static str, pub commit_short: &'static str, pub dirty: Option<bool>, pub built_at: &'static str, pub profile: &'static str, pub target: &'static str, pub rustc: &'static str, pub features: &'static str, }
Expand description

Facts fixed when the application was compiled. Get it with build_info!; every field is a &'static str in the binary, so it costs nothing at run time.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: &'static str

The application’s CARGO_PKG_NAME.

§version: &'static str

The application’s CARGO_PKG_VERSION.

§commit: &'static str

The full commit hash, or "unknown".

§commit_short: &'static str

The first 7 characters of the commit, or "unknown".

§dirty: Option<bool>

Whether uncommitted changes to tracked files were built; None when unknown.

§built_at: &'static str

The build time, RFC 3339 UTC, or "unknown".

§profile: &'static str

"release", "debug".

§target: &'static str

The target triple, or "unknown".

§rustc: &'static str

The rustc version, or "unknown".

§features: &'static str

The enabled features, comma-separated and sorted.

Implementations§

Source§

impl BuildInfo

Source

pub fn public(&self) -> PublicBuild<'_>

Only the name and version, for output that leaves your control (a public health endpoint): commit hashes and toolchain versions help an attacker fingerprint a deployment (threat T11).

let public = sys_lib::build_info!().public().to_string();
assert!(public.starts_with("sys-lib "));
Source

pub fn write_kv(&self, out: &mut impl Write) -> Result

Writes build.name=site build.version=0.3.0 ..., without allocating.

let mut line = String::new();
sys_lib::build_info!().write_kv(&mut line)?;
assert!(line.starts_with("build.name=sys-lib "));
Source

pub fn write_json(&self, out: &mut impl Write) -> Result

Writes one JSON object, without allocating; dirty is null when unknown.

let mut json = String::new();
sys_lib::build_info!().write_json(&mut json)?;
assert!(json.starts_with(r#"{"name":"sys-lib","#));

Trait Implementations§

Source§

impl Clone for BuildInfo

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BuildInfo

Source§

impl Debug for BuildInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for BuildInfo

site 0.3.0 (9db9e36, release, built 2026-10-21T18:02:11Z); unknown parts are left out, and a dirty build shows 9db9e36-dirty.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for BuildInfo

Source§

impl PartialEq for BuildInfo

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BuildInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.