775052ec49c47efc598c1119367ff2a76a992255
[anymap] / README.md
1 ``AnyMap``, a safe and convenient store for one value of each type
2 ==================================================================
3
4 [![Build Status](https://travis-ci.org/chris-morgan/anymap.svg?branch=master)](https://travis-ci.org/chris-morgan/anymap)
5
6 If you’re familiar with Go and Go web frameworks, you may have come across the common “environment” pattern for storing data related to the request. It’s typically something like ``map[string]interface{}`` and is accessed with arbitrary strings which may clash and type assertions which are a little unwieldy and must be used very carefully. (Personally I would consider that it is just *asking* for things to blow up in your face.) In a language like Go, lacking in generics, this is the best that can be done; such a thing cannot possibly be made safe without generics.
7
8 As another example of such an interface, JavaScript objects are exactly the same—a mapping of string keys to arbitrary values. (There it is actually *more* dangerous, because methods and fields/attributes/properties are on the same plane.)
9
10 Fortunately, we can do better than these things in Rust. Our type system is quite equal to easy, robust expression of such problems.
11
12 The ``AnyMap`` type is a friendly wrapper around a ``HashMap<TypeId, Box<Any>>``, exposing a nice, easy typed interface, perfectly safe and absolutely robust.
13
14 What this means is that in an ``AnyMap`` you may store zero or one values for every type.
15
16 Instructions
17 ------------
18
19 Cargo all the way: it is `anymap` on crates.io.
20
21 Author
22 ------
23
24 [Chris Morgan](http://chrismorgan.info/) ([chris-morgan](https://github.com/chris-morgan)) is the primary author and maintainer of AnyMap.
25
26 License
27 -------
28
29 This library is distributed under similar terms to Rust: dual licensed under the MIT license and the Apache license (version 2.0).
30
31 See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.