1 // Copyright 2012-2015 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 //! A pointer type for heap allocation.
13 //! `Box<T>`, casually referred to as a 'box', provides the simplest form of
14 //! heap allocation in Rust. Boxes provide ownership for this allocation, and
15 //! drop their contents when they go out of scope.
22 //! let x = Box::new(5);
25 //! Creating a recursive data structure:
30 //! Cons(T, Box<List<T>>),
35 //! let list: List<i32> = List::Cons(1, Box::new(List::Cons(2, Box::new(List::Nil))));
36 //! println!("{:?}", list);
40 //! This will print `Cons(1, Cons(2, Nil))`.
42 //! Recursive structures must be boxed, because if the definition of `Cons`
49 //! It wouldn't work. This is because the size of a `List` depends on how many
50 //! elements are in the list, and so we don't know how much memory to allocate
51 //! for a `Cons`. By introducing a `Box`, which has a defined size, we know how
52 //! big `Cons` needs to be.
54 #![stable(feature = "rust1", since = "1.0.0")]
61 use core::cmp::Ordering;
63 use core::hash::{self, Hash};
64 use core::marker::{self, Unsize};
66 use core::ops::{CoerceUnsized, Deref, DerefMut};
67 use core::ops::{Placer, Boxed, Place, InPlace, BoxPlace};
68 use core::ptr::{self, Unique};
69 use core::raw::{TraitObject};
71 /// A value that represents the heap. This is the default place that the `box`
72 /// keyword allocates into when no place is supplied.
74 /// The following two examples are equivalent:
77 /// #![feature(box_heap)]
79 /// #![feature(box_syntax, placement_in_syntax)]
80 /// use std::boxed::HEAP;
83 /// let foo = box(HEAP) 5;
87 #[lang = "exchange_heap"]
88 #[unstable(feature = "box_heap",
89 reason = "may be renamed; uncertain about custom allocator design",
91 pub const HEAP: ExchangeHeapSingleton =
92 ExchangeHeapSingleton { _force_singleton: () };
94 /// This the singleton type used solely for `boxed::HEAP`.
95 #[unstable(feature = "box_heap",
96 reason = "may be renamed; uncertain about custom allocator design",
98 #[derive(Copy, Clone)]
99 pub struct ExchangeHeapSingleton { _force_singleton: () }
101 /// A pointer type for heap allocation.
103 /// See the [module-level documentation](../../std/boxed/index.html) for more.
104 #[lang = "owned_box"]
105 #[stable(feature = "rust1", since = "1.0.0")]
107 pub struct Box<T: ?Sized>(Unique<T>);
109 /// `IntermediateBox` represents uninitialized backing storage for `Box`.
111 /// FIXME (pnkfelix): Ideally we would just reuse `Box<T>` instead of
112 /// introducing a separate `IntermediateBox<T>`; but then you hit
113 /// issues when you e.g. attempt to destructure an instance of `Box`,
114 /// since it is a lang item and so it gets special handling by the
115 /// compiler. Easier just to make this parallel type for now.
117 /// FIXME (pnkfelix): Currently the `box` protocol only supports
118 /// creating instances of sized types. This IntermediateBox is
119 /// designed to be forward-compatible with a future protocol that
120 /// supports creating instances of unsized types; that is why the type
121 /// parameter has the `?Sized` generalization marker, and is also why
122 /// this carries an explicit size. However, it probably does not need
123 /// to carry the explicit alignment; that is just a work-around for
124 /// the fact that the `align_of` intrinsic currently requires the
125 /// input type to be Sized (which I do not think is strictly
127 #[unstable(feature = "placement_in",
128 reason = "placement box design is still being worked out.",
130 pub struct IntermediateBox<T: ?Sized>{
134 marker: marker::PhantomData<*mut T>,
137 impl<T> Place<T> for IntermediateBox<T> {
138 fn pointer(&mut self) -> *mut T {
139 unsafe { ::core::mem::transmute(self.ptr) }
143 unsafe fn finalize<T>(b: IntermediateBox<T>) -> Box<T> {
144 let p = b.ptr as *mut T;
149 fn make_place<T>() -> IntermediateBox<T> {
150 let size = mem::size_of::<T>();
151 let align = mem::align_of::<T>();
153 let p = if size == 0 {
154 heap::EMPTY as *mut u8
157 heap::allocate(size, align)
160 panic!("Box make_place allocation failure.");
165 IntermediateBox { ptr: p, size: size, align: align, marker: marker::PhantomData }
168 impl<T> BoxPlace<T> for IntermediateBox<T> {
169 fn make_place() -> IntermediateBox<T> { make_place() }
172 impl<T> InPlace<T> for IntermediateBox<T> {
174 unsafe fn finalize(self) -> Box<T> { finalize(self) }
177 impl<T> Boxed for Box<T> {
179 type Place = IntermediateBox<T>;
180 unsafe fn finalize(b: IntermediateBox<T>) -> Box<T> { finalize(b) }
183 impl<T> Placer<T> for ExchangeHeapSingleton {
184 type Place = IntermediateBox<T>;
186 fn make_place(self) -> IntermediateBox<T> {
191 impl<T: ?Sized> Drop for IntermediateBox<T> {
195 heap::deallocate(self.ptr, self.size, self.align)
202 /// Allocates memory on the heap and then moves `x` into it.
207 /// let x = Box::new(5);
209 #[stable(feature = "rust1", since = "1.0.0")]
211 pub fn new(x: T) -> Box<T> {
216 impl<T : ?Sized> Box<T> {
217 /// Constructs a box from the raw pointer.
219 /// After this function call, pointer is owned by resulting box.
220 /// In particular, it means that `Box` destructor calls destructor
221 /// of `T` and releases memory. Since the way `Box` allocates and
222 /// releases memory is unspecified, the only valid pointer to pass
223 /// to this function is the one taken from another `Box` with
224 /// `Box::into_raw` function.
226 /// Function is unsafe, because improper use of this function may
227 /// lead to memory problems like double-free, for example if the
228 /// function is called twice on the same raw pointer.
229 #[unstable(feature = "box_raw",
230 reason = "may be renamed or moved out of Box scope",
233 // NB: may want to be called from_ptr, see comments on CStr::from_ptr
234 pub unsafe fn from_raw(raw: *mut T) -> Self {
238 /// Consumes the `Box`, returning the wrapped raw pointer.
240 /// After call to this function, caller is responsible for the memory
241 /// previously managed by `Box`, in particular caller should properly
242 /// destroy `T` and release memory. The proper way to do it is to
243 /// convert pointer back to `Box` with `Box::from_raw` function, because
244 /// `Box` does not specify, how memory is allocated.
248 /// #![feature(box_raw)]
250 /// let seventeen = Box::new(17u32);
251 /// let raw = Box::into_raw(seventeen);
252 /// let boxed_again = unsafe { Box::from_raw(raw) };
254 #[unstable(feature = "box_raw", reason = "may be renamed",
257 // NB: may want to be called into_ptr, see comments on CStr::from_ptr
258 pub fn into_raw(b: Box<T>) -> *mut T {
259 unsafe { mem::transmute(b) }
263 #[stable(feature = "rust1", since = "1.0.0")]
264 impl<T: Default> Default for Box<T> {
265 #[stable(feature = "rust1", since = "1.0.0")]
266 fn default() -> Box<T> { box Default::default() }
269 #[stable(feature = "rust1", since = "1.0.0")]
270 impl<T> Default for Box<[T]> {
271 #[stable(feature = "rust1", since = "1.0.0")]
272 fn default() -> Box<[T]> { Box::<[T; 0]>::new([]) }
275 #[stable(feature = "rust1", since = "1.0.0")]
276 impl<T: Clone> Clone for Box<T> {
277 /// Returns a new box with a `clone()` of this box's contents.
282 /// let x = Box::new(5);
283 /// let y = x.clone();
286 fn clone(&self) -> Box<T> { box {(**self).clone()} }
287 /// Copies `source`'s contents into `self` without creating a new allocation.
292 /// #![feature(box_raw)]
294 /// let x = Box::new(5);
295 /// let mut y = Box::new(10);
297 /// y.clone_from(&x);
299 /// assert_eq!(*y, 5);
302 fn clone_from(&mut self, source: &Box<T>) {
303 (**self).clone_from(&(**source));
308 #[stable(feature = "box_slice_clone", since = "1.3.0")]
309 impl Clone for Box<str> {
310 fn clone(&self) -> Self {
311 let len = self.len();
312 let buf = RawVec::with_capacity(len);
314 ptr::copy_nonoverlapping(self.as_ptr(), buf.ptr(), len);
315 mem::transmute(buf.into_box()) // bytes to str ~magic
320 #[stable(feature = "rust1", since = "1.0.0")]
321 impl<T: ?Sized + PartialEq> PartialEq for Box<T> {
323 fn eq(&self, other: &Box<T>) -> bool { PartialEq::eq(&**self, &**other) }
325 fn ne(&self, other: &Box<T>) -> bool { PartialEq::ne(&**self, &**other) }
327 #[stable(feature = "rust1", since = "1.0.0")]
328 impl<T: ?Sized + PartialOrd> PartialOrd for Box<T> {
330 fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering> {
331 PartialOrd::partial_cmp(&**self, &**other)
334 fn lt(&self, other: &Box<T>) -> bool { PartialOrd::lt(&**self, &**other) }
336 fn le(&self, other: &Box<T>) -> bool { PartialOrd::le(&**self, &**other) }
338 fn ge(&self, other: &Box<T>) -> bool { PartialOrd::ge(&**self, &**other) }
340 fn gt(&self, other: &Box<T>) -> bool { PartialOrd::gt(&**self, &**other) }
342 #[stable(feature = "rust1", since = "1.0.0")]
343 impl<T: ?Sized + Ord> Ord for Box<T> {
345 fn cmp(&self, other: &Box<T>) -> Ordering {
346 Ord::cmp(&**self, &**other)
349 #[stable(feature = "rust1", since = "1.0.0")]
350 impl<T: ?Sized + Eq> Eq for Box<T> {}
352 #[stable(feature = "rust1", since = "1.0.0")]
353 impl<T: ?Sized + Hash> Hash for Box<T> {
354 fn hash<H: hash::Hasher>(&self, state: &mut H) {
355 (**self).hash(state);
361 #[stable(feature = "rust1", since = "1.0.0")]
362 /// Attempt to downcast the box to a concrete type.
363 pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any>> {
366 // Get the raw representation of the trait object
367 let raw = Box::into_raw(self);
368 let to: TraitObject =
369 mem::transmute::<*mut Any, TraitObject>(raw);
371 // Extract the data pointer
372 Ok(Box::from_raw(to.data as *mut T))
380 impl Box<Any + Send> {
382 #[stable(feature = "rust1", since = "1.0.0")]
383 /// Attempt to downcast the box to a concrete type.
384 pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any + Send>> {
385 <Box<Any>>::downcast(self).map_err(|s| unsafe {
386 // reapply the Send marker
387 mem::transmute::<Box<Any>, Box<Any + Send>>(s)
392 #[stable(feature = "rust1", since = "1.0.0")]
393 impl<T: fmt::Display + ?Sized> fmt::Display for Box<T> {
394 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
395 fmt::Display::fmt(&**self, f)
399 #[stable(feature = "rust1", since = "1.0.0")]
400 impl<T: fmt::Debug + ?Sized> fmt::Debug for Box<T> {
401 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
402 fmt::Debug::fmt(&**self, f)
406 #[stable(feature = "rust1", since = "1.0.0")]
407 impl<T> fmt::Pointer for Box<T> {
408 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
409 // It's not possible to extract the inner Uniq directly from the Box,
410 // instead we cast it to a *const which aliases the Unique
411 let ptr: *const T = &**self;
412 fmt::Pointer::fmt(&ptr, f)
416 #[stable(feature = "rust1", since = "1.0.0")]
417 impl<T: ?Sized> Deref for Box<T> {
420 fn deref(&self) -> &T { &**self }
423 #[stable(feature = "rust1", since = "1.0.0")]
424 impl<T: ?Sized> DerefMut for Box<T> {
425 fn deref_mut(&mut self) -> &mut T { &mut **self }
428 #[stable(feature = "rust1", since = "1.0.0")]
429 impl<I: Iterator + ?Sized> Iterator for Box<I> {
431 fn next(&mut self) -> Option<I::Item> { (**self).next() }
432 fn size_hint(&self) -> (usize, Option<usize>) { (**self).size_hint() }
434 #[stable(feature = "rust1", since = "1.0.0")]
435 impl<I: DoubleEndedIterator + ?Sized> DoubleEndedIterator for Box<I> {
436 fn next_back(&mut self) -> Option<I::Item> { (**self).next_back() }
438 #[stable(feature = "rust1", since = "1.0.0")]
439 impl<I: ExactSizeIterator + ?Sized> ExactSizeIterator for Box<I> {}
442 /// `FnBox` is a version of the `FnOnce` intended for use with boxed
443 /// closure objects. The idea is that where one would normally store a
444 /// `Box<FnOnce()>` in a data structure, you should use
445 /// `Box<FnBox()>`. The two traits behave essentially the same, except
446 /// that a `FnBox` closure can only be called if it is boxed. (Note
447 /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
448 /// closures become directly usable.)
452 /// Here is a snippet of code which creates a hashmap full of boxed
453 /// once closures and then removes them one by one, calling each
454 /// closure as it is removed. Note that the type of the closures
455 /// stored in the map is `Box<FnBox() -> i32>` and not `Box<FnOnce()
459 /// #![feature(fnbox)]
461 /// use std::boxed::FnBox;
462 /// use std::collections::HashMap;
464 /// fn make_map() -> HashMap<i32, Box<FnBox() -> i32>> {
465 /// let mut map: HashMap<i32, Box<FnBox() -> i32>> = HashMap::new();
466 /// map.insert(1, Box::new(|| 22));
467 /// map.insert(2, Box::new(|| 44));
472 /// let mut map = make_map();
473 /// for i in &[1, 2] {
474 /// let f = map.remove(&i).unwrap();
475 /// assert_eq!(f(), i * 22);
480 #[unstable(feature = "fnbox", reason = "Newly introduced", issue = "0")]
484 fn call_box(self: Box<Self>, args: A) -> Self::Output;
487 impl<A,F> FnBox<A> for F
490 type Output = F::Output;
492 fn call_box(self: Box<F>, args: A) -> F::Output {
497 impl<'a,A,R> FnOnce<A> for Box<FnBox<A,Output=R>+'a> {
500 extern "rust-call" fn call_once(self, args: A) -> R {
505 impl<'a,A,R> FnOnce<A> for Box<FnBox<A,Output=R>+Send+'a> {
508 extern "rust-call" fn call_once(self, args: A) -> R {
513 impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<Box<U>> for Box<T> {}
515 #[stable(feature = "box_slice_clone", since = "1.3.0")]
516 impl<T: Clone> Clone for Box<[T]> {
517 fn clone(&self) -> Self {
518 let mut new = BoxBuilder {
519 data: RawVec::with_capacity(self.len()),
523 let mut target = new.data.ptr();
525 for item in self.iter() {
527 ptr::write(target, item.clone());
528 target = target.offset(1);
534 return unsafe { new.into_box() };
536 // Helper type for responding to panics correctly.
537 struct BoxBuilder<T> {
542 impl<T> BoxBuilder<T> {
543 unsafe fn into_box(self) -> Box<[T]> {
544 let raw = ptr::read(&self.data);
550 impl<T> Drop for BoxBuilder<T> {
552 let mut data = self.data.ptr();
553 let max = unsafe { data.offset(self.len as isize) };
558 data = data.offset(1);
566 impl<T: ?Sized> borrow::Borrow<T> for Box<T> {
567 fn borrow(&self) -> &T { &**self }
570 impl<T: ?Sized> borrow::BorrowMut<T> for Box<T> {
571 fn borrow_mut(&mut self) -> &mut T { &mut **self }