ffdbe325fd70f40755a3a9ea5ca0bd597bfb6e42
[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.
7
8 This is madness. Hare-brained, stark, raving madness, just *asking* for things to blow up in your face. Unfortunately for people in Go, it’s the best that they can have because of its weak type system; such a thing cannot possibly be made safe without generics.
9
10 Fortunately, we can do better 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>:'static>``, 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 make
20
21 Future work
22 -----------
23
24 I think that the only thing left for this is filling out additional methods from ``HashMap`` as appropriate.
25
26 It’s a very simple thing.
27
28 Author
29 ------
30
31 [Chris Morgan](http://chrismorgan.info/) ([chris-morgan](https://github.com/chris-morgan)) is the primary author and maintainer of AnyMap.
32
33 License
34 -------
35
36 This library is distributed under similar terms to Rust: dual licensed under the MIT license and the Apache license (version 2.0).
37
38 See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.