Skip to content
This repository has been archived by the owner on Sep 6, 2022. It is now read-only.

Latest commit

 

History

History
35 lines (26 loc) · 1.48 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.48 KB

startup: Run Rust code "before main"

Build Status Docs Latest Version Minimum Rust Version

Tiny (no dependency, no proc macro) way to run some code before main. This is similar to the GNU C extension __attribute__((constructor)), or the behavior of static constructors from C++.

Usage

startup::on_startup! {
    // Note: not all of the rust stdlib may be supported before main.
    println!("I'm running before main");
}
fn main() {
    println!("I'm inside main");
}

Prints:

I'm running before main.
I'm inside main.

Comparison with ctor

This crate is the moral equivalent to the ctor crate, although the API is completely different. The main reasons for it's existence are:

  • Much faster to compile — no proc macros / syn / quote.
  • More obviously safe. No support for #[ctor] on statics, no #[dtor] equivalent, and avoids a number of issues I filed with ctor in the past...
  • Handle untested unix platforms by assuming they support at least the .ctors section. This is in line with what clang seems to do when compiling C++ static constructors. This means we should expect to have better platform support.