abio 0.3.0

Safe abstractions for interfacing with the native operating system ABI.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# Load environment variables from .env file.
set dotenv-load := true

# Set shell for executing commands
set windows-shell := ["pwsh", "-NoProfile", "-NoLogo", "-Command"]
set shell := ["bash", "-cu"]

# Workspace-local variables
release_mode := "--release"
compiler_target := if os_family() == "windows" { "x86_64-pc-windows-msvc" } else { "x86_64-unknown-linux-gnu" }
rust_toolchain := "nightly"

# List all available recipes
_default:
    @just --list

show-target:
    echo "{{ compiler_target }} with {{ rust_toolchain }} toolchain"

# Bootstrap environment, verifying all tools are installed
bootstrap:
    rustup default {{ rust_toolchain }}
    cargo binstall cargo-audit cargo-expand cargo-watch

# Run benchmark suite
bench:
    cargo +nightly bench

# Build project in debug or release mode
build *MODE:
    cargo build --workspace --target={{compiler_target}} {{ if MODE != "" { release_mode } else { "" } }}

# Build project in debug or release mode and update Cargo.lock
build-locked *MODE:
    cargo build --workspace --all-targets --locked {{ if MODE != "" { release_mode } else { "" } }}
    
# Build project (debug and release mode)
@build-all:
    @just build
    @just build release

# Compile, test and lint project, failing on error
@check:
    cargo +nightly fmt --all -- --check && \
    cargo test --workspace --quiet && \
    cargo +nightly clippy --workspace --all-targets -- -D warnings

# Remove build artifacts
@clean:
    cargo clean --verbose

# Compile project
@compile:
    cargo check --workspace --all-targets

# Build documentation, opening in a browser
@docs:
    cargo +nightly doc --workspace --all-features --no-deps --open

# Build documentation, opening in a browser
@docs-all:
    cargo +nightly doc --workspace --all-features --no-deps --document-private-items --open

# Run tests against Miri
@miri:
    cargo miri test

# Run tests against Miri (verbose mode)
@miri-verbose:
    cargo miri test -- --nocapture

# Lint project with clippy
@lint:
    cargo +nightly clippy --workspace --all-targets

# Rebuild project from scratch
@rebuild:
    @just clean
    @just build
    @just build release

# Run project binary
@run name:
    cargo run --bin {{name}}

# Run test suite
@test:
    cargo test --workspace --all-targets --quiet

# Run test suite (release mode)
@test-release:
    cargo test --workspace --quiet --all-targets --release

# Run test suite (debug mode with multi-threaded environment)
@test-verbose:
    cargo test --workspace --all-targets -- --nocapture

# Run test suite (debug mode with single-threaded environment)
@test-debug:
    cargo test --workspace --all-targets -- --test-threads=1 --nocapture

# Get compilation timings [fmt: html, json]
@timings fmt:
    @just clean
    cargo build --workspace --all-targets --release -Z timings={{fmt}}

# Show the versions of required build tools
@versions:
    rustc --version
    cargo --version

# Run recipe in watch mode, restarting on changes
@watch recipe:
    cargo watch -s "just {{ recipe }}"