1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Traits for dynamic typing of any `'static` type (through runtime reflection)
13 //! This module implements the `Any` trait, which enables dynamic typing
14 //! of any `'static` type through runtime reflection.
16 //! `Any` itself can be used to get a `TypeId`, and has more features when used
17 //! as a trait object. As `&Any` (a borrowed trait object), it has the `is` and
18 //! `as_ref` methods, to test if the contained value is of a given type, and to
19 //! get a reference to the inner value as a type. As`&mut Any`, there is also
20 //! the `as_mut` method, for getting a mutable reference to the inner value.
21 //! `Box<Any>` adds the `move` method, which will unwrap a `Box<T>` from the
22 //! object. See the extension traits (`*Ext`) for the full details.
24 //! Note that &Any is limited to testing whether a value is of a specified
25 //! concrete type, and cannot be used to test whether a type implements a trait.
29 //! Consider a situation where we want to log out a value passed to a function.
30 //! We know the value we're working on implements Debug, but we don't know its
31 //! concrete type. We want to give special treatment to certain types: in this
32 //! case printing out the length of String values prior to their value.
33 //! We don't know the concrete type of our value at compile time, so we need to
34 //! use runtime reflection instead.
37 //! use std::fmt::Debug;
38 //! use std::any::Any;
40 //! // Logger function for any type that implements Debug.
41 //! fn log<T: Any + Debug>(value: &T) {
42 //! let value_any = value as &Any;
44 //! // try to convert our value to a String. If successful, we want to
45 //! // output the String's length as well as its value. If not, it's a
46 //! // different type: just print it out unadorned.
47 //! match value_any.downcast_ref::<String>() {
48 //! Some(as_string) => {
49 //! println!("String ({}): {}", as_string.len(), as_string);
52 //! println!("{:?}", value);
57 //! // This function wants to log its parameter out prior to doing work with it.
58 //! fn do_work<T: Any + Debug>(value: &T) {
60 //! // ...do some other work
64 //! let my_string = "Hello World".to_string();
65 //! do_work(&my_string);
67 //! let my_i8: i8 = 100;
72 #![stable(feature = "rust1", since = "1.0.0")]
77 use option::Option::{self, Some, None};
80 use marker::{Reflect, Sized};
82 ///////////////////////////////////////////////////////////////////////////////
84 ///////////////////////////////////////////////////////////////////////////////
86 /// A type to emulate dynamic typing.
88 /// Every type with no non-`'static` references implements `Any`.
89 /// See the [module-level documentation][mod] for more details.
92 #[stable(feature = "rust1", since = "1.0.0")]
93 pub trait Any: Reflect + 'static {
94 /// Gets the `TypeId` of `self`.
95 #[unstable(feature = "get_type_id",
96 reason = "this method will likely be replaced by an associated static")]
97 fn get_type_id(&self) -> TypeId;
100 impl<T: Reflect + 'static> Any for T {
101 fn get_type_id(&self) -> TypeId { TypeId::of::<T>() }
104 ///////////////////////////////////////////////////////////////////////////////
105 // Extension methods for Any trait objects.
106 ///////////////////////////////////////////////////////////////////////////////
108 #[stable(feature = "rust1", since = "1.0.0")]
109 impl fmt::Debug for Any {
110 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
115 // Ensure that the result of e.g. joining a thread can be printed and
116 // hence used with `unwrap`. May eventually no longer be needed if
117 // dispatch works with upcasting.
118 #[stable(feature = "rust1", since = "1.0.0")]
119 impl fmt::Debug for Any + Send {
120 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
126 /// Returns true if the boxed type is the same as `T`
127 #[stable(feature = "rust1", since = "1.0.0")]
129 pub fn is<T: Any>(&self) -> bool {
130 // Get TypeId of the type this function is instantiated with
131 let t = TypeId::of::<T>();
133 // Get TypeId of the type in the trait object
134 let boxed = self.get_type_id();
136 // Compare both TypeIds on equality
140 /// Returns some reference to the boxed value if it is of type `T`, or
141 /// `None` if it isn't.
142 #[stable(feature = "rust1", since = "1.0.0")]
144 pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
147 // Get the raw representation of the trait object
148 let to: TraitObject = transmute(self);
150 // Extract the data pointer
151 Some(transmute(to.data))
158 /// Returns some mutable reference to the boxed value if it is of type `T`, or
159 /// `None` if it isn't.
160 #[stable(feature = "rust1", since = "1.0.0")]
162 pub fn downcast_mut<T: Any>(&mut self) -> Option<&mut T> {
165 // Get the raw representation of the trait object
166 let to: TraitObject = transmute(self);
168 // Extract the data pointer
169 Some(transmute(to.data))
178 /// Forwards to the method defined on the type `Any`.
179 #[stable(feature = "rust1", since = "1.0.0")]
181 pub fn is<T: Any>(&self) -> bool {
185 /// Forwards to the method defined on the type `Any`.
186 #[stable(feature = "rust1", since = "1.0.0")]
188 pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
189 Any::downcast_ref::<T>(self)
192 /// Forwards to the method defined on the type `Any`.
193 #[stable(feature = "rust1", since = "1.0.0")]
195 pub fn downcast_mut<T: Any>(&mut self) -> Option<&mut T> {
196 Any::downcast_mut::<T>(self)
201 ///////////////////////////////////////////////////////////////////////////////
202 // TypeID and its methods
203 ///////////////////////////////////////////////////////////////////////////////
205 /// A `TypeId` represents a globally unique identifier for a type.
207 /// Each `TypeId` is an opaque object which does not allow inspection of what's
208 /// inside but does allow basic operations such as cloning, comparison,
209 /// printing, and showing.
211 /// A `TypeId` is currently only available for types which ascribe to `'static`,
212 /// but this limitation may be removed in the future.
213 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
214 #[stable(feature = "rust1", since = "1.0.0")]
220 /// Returns the `TypeId` of the type this generic function has been
221 /// instantiated with
222 #[stable(feature = "rust1", since = "1.0.0")]
223 pub fn of<T: ?Sized + Reflect + 'static>() -> TypeId {
225 t: unsafe { intrinsics::type_id::<T>() },