Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.13 KB

README.md

File metadata and controls

48 lines (35 loc) · 2.13 KB

Staticize

Crates.io docs.rs MIT License

Staticize contains a Staticize trait providing a handy associated type Static which resolves to a 'static version of T for all T that implement Staticize. Staticize is implemented on all primitives, as well as references, tuples up to size 16, arrays, and slices of any T that implements Staticize. Implementations are also provided for a variety of built-in types including but not limited to Option, Result and atomics. std and alloc features are also included that provide more impls.

Use Cases

Staticize is useful for situations where you have a T but for whatever reason need a 'static version of it, such as when you are working with type-erased heap allocations, as is the case with my interned crate. Another common use-case is situations where a static version of a type is needed for some generic method, such as TypeId::of.

For example, a method that takes a value of type T, stores it in a static on the heap, and returns a 'static reference to the static version of the data on the heap, might use the following signature:

pub fn heap_allocate<T: Staticize>(val: T) -> T::Static {
  // ...
}

Features

Two convenience methods, static_type_id and static_type_name are also provided on Staticize. These use the facilities in core::any to return the underlying TypeId and name (as a &'static str) of the static version of T.

Staticize is completely no_std, so it can be used in exotic scenarios where the standard library is not available, such as embedded devices or in WASM.

std

The std feature adds additional impls for std types, such as String, Vec, etc.

alloc

The alloc feature adds additional impls for alloc types that are no_std safe, such as String, Vec, etc.