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 //! This module implements the `Any` trait, which enables dynamic typing
12 //! of any `'static` type through runtime reflection.
14 //! `Any` itself can be used to get a `TypeId`, and has more features when used
15 //! as a trait object. As `&Any` (a borrowed trait object), it has the `is` and
16 //! `downcast_ref` methods, to test if the contained value is of a given type,
17 //! and to get a reference to the inner value as a type. As `&mut Any`, there
18 //! is also the `downcast_mut` method, for getting a mutable reference to the
19 //! inner value. `Box<Any>` adds the `downcast` method, which attempts to
20 //! convert to a `Box<T>`. See the [`Box`] documentation for the full details.
22 //! Note that &Any is limited to testing whether a value is of a specified
23 //! concrete type, and cannot be used to test whether a type implements a trait.
25 //! [`Box`]: ../../std/boxed/struct.Box.html
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 /// Most types implement `Any`. However, any type which contains a non-`'static` reference does not.
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`.
99 /// #![feature(get_type_id)]
101 /// use std::any::{Any, TypeId};
103 /// fn is_string(s: &Any) -> bool {
104 /// TypeId::of::<String>() == s.get_type_id()
108 /// assert_eq!(is_string(&0), false);
109 /// assert_eq!(is_string(&"cookie monster".to_owned()), true);
112 #[unstable(feature = "get_type_id",
113 reason
= "this method will likely be replaced by an associated static",
115 fn get_type_id(&self) -> TypeId
;
118 #[stable(feature = "rust1", since = "1.0.0")]
119 impl<T
: Reflect
+ '
static + ?Sized
> Any
for T
{
120 fn get_type_id(&self) -> TypeId { TypeId::of::<T>() }
123 ///////////////////////////////////////////////////////////////////////////////
124 // Extension methods for Any trait objects.
125 ///////////////////////////////////////////////////////////////////////////////
127 #[stable(feature = "rust1", since = "1.0.0")]
128 impl fmt
::Debug
for Any
{
129 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
134 // Ensure that the result of e.g. joining a thread can be printed and
135 // hence used with `unwrap`. May eventually no longer be needed if
136 // dispatch works with upcasting.
137 #[stable(feature = "rust1", since = "1.0.0")]
138 impl fmt
::Debug
for Any
+ Send
{
139 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
145 /// Returns true if the boxed type is the same as `T`.
150 /// use std::any::Any;
152 /// fn is_string(s: &Any) {
153 /// if s.is::<String>() {
154 /// println!("It's a string!");
156 /// println!("Not a string...");
162 /// is_string(&"cookie monster".to_owned());
165 #[stable(feature = "rust1", since = "1.0.0")]
167 pub fn is
<T
: Any
>(&self) -> bool
{
168 // Get TypeId of the type this function is instantiated with
169 let t
= TypeId
::of
::<T
>();
171 // Get TypeId of the type in the trait object
172 let boxed
= self.get_type_id();
174 // Compare both TypeIds on equality
178 /// Returns some reference to the boxed value if it is of type `T`, or
179 /// `None` if it isn't.
184 /// use std::any::Any;
186 /// fn print_if_string(s: &Any) {
187 /// if let Some(string) = s.downcast_ref::<String>() {
188 /// println!("It's a string({}): '{}'", string.len(), string);
190 /// println!("Not a string...");
195 /// print_if_string(&0);
196 /// print_if_string(&"cookie monster".to_owned());
199 #[stable(feature = "rust1", since = "1.0.0")]
201 pub fn downcast_ref
<T
: Any
>(&self) -> Option
<&T
> {
204 // Get the raw representation of the trait object
205 let to
: TraitObject
= transmute(self);
207 // Extract the data pointer
208 Some(&*(to
.data
as *const T
))
215 /// Returns some mutable reference to the boxed value if it is of type `T`, or
216 /// `None` if it isn't.
221 /// use std::any::Any;
223 /// fn modify_if_u32(s: &mut Any) {
224 /// if let Some(num) = s.downcast_mut::<u32>() {
230 /// let mut x = 10u32;
231 /// let mut s = "starlord".to_owned();
233 /// modify_if_u32(&mut x);
234 /// modify_if_u32(&mut s);
236 /// assert_eq!(x, 42);
237 /// assert_eq!(&s, "starlord");
240 #[stable(feature = "rust1", since = "1.0.0")]
242 pub fn downcast_mut
<T
: Any
>(&mut self) -> Option
<&mut T
> {
245 // Get the raw representation of the trait object
246 let to
: TraitObject
= transmute(self);
248 // Extract the data pointer
249 Some(&mut *(to
.data
as *const T
as *mut T
))
258 /// Forwards to the method defined on the type `Any`.
263 /// use std::any::Any;
265 /// fn is_string(s: &(Any + Send)) {
266 /// if s.is::<String>() {
267 /// println!("It's a string!");
269 /// println!("Not a string...");
275 /// is_string(&"cookie monster".to_owned());
278 #[stable(feature = "rust1", since = "1.0.0")]
280 pub fn is
<T
: Any
>(&self) -> bool
{
284 /// Forwards to the method defined on the type `Any`.
289 /// use std::any::Any;
291 /// fn print_if_string(s: &(Any + Send)) {
292 /// if let Some(string) = s.downcast_ref::<String>() {
293 /// println!("It's a string({}): '{}'", string.len(), string);
295 /// println!("Not a string...");
300 /// print_if_string(&0);
301 /// print_if_string(&"cookie monster".to_owned());
304 #[stable(feature = "rust1", since = "1.0.0")]
306 pub fn downcast_ref
<T
: Any
>(&self) -> Option
<&T
> {
307 Any
::downcast_ref
::<T
>(self)
310 /// Forwards to the method defined on the type `Any`.
315 /// use std::any::Any;
317 /// fn modify_if_u32(s: &mut (Any+ Send)) {
318 /// if let Some(num) = s.downcast_mut::<u32>() {
324 /// let mut x = 10u32;
325 /// let mut s = "starlord".to_owned();
327 /// modify_if_u32(&mut x);
328 /// modify_if_u32(&mut s);
330 /// assert_eq!(x, 42);
331 /// assert_eq!(&s, "starlord");
334 #[stable(feature = "rust1", since = "1.0.0")]
336 pub fn downcast_mut
<T
: Any
>(&mut self) -> Option
<&mut T
> {
337 Any
::downcast_mut
::<T
>(self)
342 ///////////////////////////////////////////////////////////////////////////////
343 // TypeID and its methods
344 ///////////////////////////////////////////////////////////////////////////////
346 /// A `TypeId` represents a globally unique identifier for a type.
348 /// Each `TypeId` is an opaque object which does not allow inspection of what's
349 /// inside but does allow basic operations such as cloning, comparison,
350 /// printing, and showing.
352 /// A `TypeId` is currently only available for types which ascribe to `'static`,
353 /// but this limitation may be removed in the future.
354 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
355 #[stable(feature = "rust1", since = "1.0.0")]
361 /// Returns the `TypeId` of the type this generic function has been
362 /// instantiated with.
367 /// #![feature(get_type_id)]
369 /// use std::any::{Any, TypeId};
371 /// fn is_string(s: &Any) -> bool {
372 /// TypeId::of::<String>() == s.get_type_id()
376 /// assert_eq!(is_string(&0), false);
377 /// assert_eq!(is_string(&"cookie monster".to_owned()), true);
380 #[stable(feature = "rust1", since = "1.0.0")]
381 pub fn of
<T
: ?Sized
+ Reflect
+ '
static>() -> TypeId
{
383 t
: unsafe { intrinsics::type_id::<T>() }
,