From a294948f57dee47bb284d6a3ae1b8f61a902a03c Mon Sep 17 00:00:00 2001 From: Chris Morgan Date: Thu, 12 Jun 2014 17:29:24 +1000 Subject: [PATCH] Initial release. --- .gitignore | 3 + .travis.yml | 12 +++ COPYRIGHT | 3 + LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 25 ++++++ Makefile | 57 ++++++++++++++ README | 36 +++++++++ src/lib.rs | 73 ++++++++++++++++++ 8 files changed, 410 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 COPYRIGHT create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 Makefile create mode 100644 README create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..92de2ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/ +TAGS +doc/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..4e6dc6b --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +env: + global: + - secure: o2bgX4ObmN5b/lG2pk7U4tSu2/h0tLUxhHe3X6ZHi7A6MFOMtZOV+7g5TJX94YyAcsT5AWFSnl1Wv4dZcIJXsFkcZguFu6WI/Psc09K3zsA6NtXrqdcKv7XRBxivTKvfZ14PYhLgOuU+o1HreCQvolr5nmiX2gORmvD2Xc3qbHI= +before_install: + - wget http://static.rust-lang.org/dist/rust-nightly-x86_64-unknown-linux-gnu.tar.gz + - tar xf rust-nightly-x86_64-unknown-linux-gnu.tar.gz +install: + - sudo ./rust-nightly-x86_64-unknown-linux-gnu/install.sh +script: + - make all docs test +after_script: + - curl http://www.rust-ci.org/artifacts/put?t=$RUSTCI_TOKEN | sh diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..55c8f9f --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,3 @@ +This project is dual-licensed under the terms of the MIT and Apache (version 2.0) licenses. + +Copyright (c) 2014 Chris Morgan and the Teepee project developers diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..6866f31 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2014 Chris Morgan and the Teepee project developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..863c961 --- /dev/null +++ b/Makefile @@ -0,0 +1,57 @@ +RUSTC ?= rustc +RUSTDOC ?= rustdoc +RUSTFLAGS ?= -O +RUST_REPOSITORY ?= ../rust +RUST_CTAGS ?= $(RUST_REPOSITORY)/src/etc/ctags.rust + +all: anymap docs test + +# Recursive wildcard function +# http://blog.jgc.org/2011/07/gnu-make-recursive-wildcard-function.html +rwildcard=$(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2) \ + $(filter $(subst *,%,$2),$d)) + +SRC := $(call rwildcard,src/,*.rs) +LIB := build/$(shell rustc --crate-file-name src/lib.rs --crate-type rlib) +ifeq ($(LIB),build/) +# We may not have rustc or the lib.rs file may be broken. +# But don't break the rules on that account. +LIB := build/libanymap.dummy +endif + +anymap: $(LIB) + +$(LIB): $(SRC) + @mkdir -p build/ + $(RUSTC) $(RUSTFLAGS) src/lib.rs --out-dir=build -L build + +doc/anymap/index.html: $(SRC) + $(RUSTDOC) src/lib.rs -L build + +build/test: $(SRC) + $(RUSTC) $(RUSTFLAGS) --test -o build/test src/lib.rs -L build + +build/quicktest: $(SRC) + $(RUSTC) --test -o build/quicktest src/lib.rs -L build + +# There are no tests to run this way at present. It’s all doctests. +# test: anymap doctest build/test +# build/test --test +test: anymap doctest + +doctest: $(SRC) $(LIB) + $(RUSTDOC) -L build --test src/lib.rs + +# Can't wait for everything to build, optimised too? OK, you can save some time here. +quicktest: build/quicktest + build/quicktest --test + +docs: doc/anymap/index.html + +clean: + rm -rf build/ doc/ + +TAGS: $(SRC) + ctags -f TAGS --options="$(RUST_CTAGS)" --language=rust -R src/ + +.PHONY: all docs clean test doctest quicktest anymap diff --git a/README b/README new file mode 100644 index 0000000..9f9cf95 --- /dev/null +++ b/README @@ -0,0 +1,36 @@ +``AnyMap`` +========== + +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. + +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. + +Fortunately, we can do better in Rust. Our type system is quite equal to easy, robust expression of such problems. + +The ``AnyMap`` type is a friendly wrapper around a ``HashMap:'static>``, exposing a nice, easy typed interface, perfectly safe and absolutely robust. + +What this means is that in an ``AnyMap`` you may store zero or one values for every type. + +Instructions +------------ + + make + +Future work +----------- + +I think that the only thing left for this is filling out additional methods from ``HashMap`` as appropriate. + +It’s a very simple thing. + +Author +------ + +[Chris Morgan](http://chrismorgan.info/) ([chris-morgan](https://github.com/chris-morgan)) is the primary author and maintainer of AnyMap. + +License +------- + +This library is distributed under similar terms to Rust: dual licensed under the MIT license and the Apache license (version 2.0). + +See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..8bc9a17 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,73 @@ +//! This crate provides the `AnyMap` type, a safe and convenient store for one value of each type. + +#![crate_id = "anymap#0.9"] +#![crate_type = "rlib"] +#![crate_type = "dylib"] +#![warn(unnecessary_qualification, non_uppercase_statics, unsafe_block, + variant_size_difference, managed_heap_memory, unnecessary_typecast, + missing_doc, unused_result, deprecated_owned_vector)] + +use std::any::{Any, AnyRefExt, AnyMutRefExt}; +use std::intrinsics::TypeId; +use std::collections::HashMap; + +/// A map containing zero or one values for any given type and allowing convenient, +/// type-safe access to those values. +/// +/// ```rust +/// # use anymap::AnyMap; +/// let mut data = AnyMap::new(); +/// assert_eq!(data.find(), None::<&int>); +/// data.insert(42i); +/// assert_eq!(data.find(), Some(&42i)); +/// data.remove::(); +/// assert_eq!(data.find::(), None); +/// +/// #[deriving(PartialEq, Show)] +/// struct Foo { +/// str: String, +/// } +/// +/// assert_eq!(data.find::(), None); +/// data.insert(Foo { str: "foo".to_string() }); +/// assert_eq!(data.find(), Some(&Foo { str: "foo".to_string() })); +/// data.find_mut::().map(|foo| foo.str.push_char('t')); +/// assert_eq!(data.find::().unwrap().str.as_slice(), "foot"); +/// ``` +/// +/// Values containing non-static references are not permitted. +pub struct AnyMap { + data: HashMap:'static>, +} + +impl AnyMap { + /// Construct a new `AnyMap`. + pub fn new() -> AnyMap { + AnyMap { + data: HashMap::new(), + } + } +} + +impl AnyMap { + /// Retrieve the value stored in the map for the type `T`, if it exists. + pub fn find<'a, T: 'static>(&'a self) -> Option<&'a T> { + self.data.find(&TypeId::of::()).and_then(|any| any.as_ref::()) + } + + /// Retrieve a mutable reference to the value stored in the map for the type `T`, if it exists. + pub fn find_mut<'a, T: 'static>(&'a mut self) -> Option<&'a mut T> { + self.data.find_mut(&TypeId::of::()).and_then(|any| any.as_mut::()) + } + + /// Set the value contained in the map for the type `T`. + /// This will override any previous value stored. + pub fn insert(&mut self, value: T) { + self.data.insert(TypeId::of::(), box value as Box:'static); + } + + /// Remove the value for the type `T` if it existed. + pub fn remove(&mut self) { + self.data.remove(&TypeId::of::()); + } +}