Struct Settings 

pub struct Settings { /* private fields */ }

Configuration for a Hegel test run.

Use builder methods to customize, then pass to [Hegel::settings] or the settings parameter of #[hegel::test].

In CI environments (detected automatically), the database is disabled and tests are derandomized by default.

Implementations

impl Settings

pub fn new() -> Self

Create settings with defaults. Detects CI environments automatically.

pub fn test_cases(self, n: u64) -> Self

Set the number of test cases to run (default: 100).

pub fn verbosity(self, verbosity: Verbosity) -> Self

Set the verbosity level.

pub fn seed(self, seed: Option<u64>) -> Self

Set a fixed seed for reproducibility, or None for random.

pub fn derandomize(self, derandomize: bool) -> Self

When true, use a fixed seed derived from the test name. Enabled by default in CI.

pub fn database(self, database: Option<String>) -> Self

Set the database path for storing failing examples, or None to disable.

pub fn suppress_health_check( self, checks: impl IntoIterator<Item = HealthCheck>, ) -> Self

Suppress one or more health checks so they do not cause test failure.

Health checks detect common issues like excessive filtering or slow tests. Use this to suppress specific checks when they are expected.

Example

use hegel::{HealthCheck, Verbosity};
use hegel::generators as gs;

#[hegel::test(suppress_health_check = [HealthCheck::FilterTooMuch, HealthCheck::TooSlow])]
fn my_test(tc: hegel::TestCase) {
    let n: i32 = tc.draw(gs::integers());
    tc.assume(n > 0);
}

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.