#debug-mode #debugging #mutable #static #const #release #interactive-applications

dirty_static

A container for an immutable value that allows sneaky reloading in debug mode (via UnsafeCell) while keeping the data safe and constant in release mode. This allows you to tweak data while testing an application, without having that data be mutable when the application is released. Intended for use with game assets, but suitable for any interactive application

2 releases

0.1.1 Oct 20, 2019
0.1.0 Oct 20, 2019

#506 in Configuration

CC0 license

10KB
135 lines

dirty_static

Build Status Crates.io Docs.rs

This crate provides a container for a value, DirtyStatic, which allows mutation in debug mode (via UnsafeCell), but not in release mode.

This allows you to tweak data while testing an application, without having that data be mutable when the application is released.

There are also two features available:

  1. force-dynamic which allows replacing the value of a DirtyStatic even in release mode.
  2. force-static which disallows replacing the value of a DirtyStatic even in debug mode.

Usage

// In debug mode
use dirty_static::DirtyStatic;

let c = DirtyStatic::new(100);
unsafe {
    c.replace(200);
}

assert_eq!(*c, 200);
// In release mode
use dirty_static::DirtyStatic;

let c = DirtyStatic::new(100);
unsafe {
    c.replace(200);
}

assert_eq!(*c, 100);

No runtime deps

Features