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`
45 //! ```compile_fail,E0072
51 //! It wouldn't work. This is because the size of a `List` depends on how many
52 //! elements are in the list, and so we don't know how much memory to allocate
53 //! for a `Cons`. By introducing a `Box`, which has a defined size, we know how
54 //! big `Cons` needs to be.
56 #![stable(feature = "rust1", since = "1.0.0")]
58 use heap
::{Heap, Layout, Alloc}
;
63 use core
::cmp
::Ordering
;
65 use core
::hash
::{self, Hash}
;
66 use core
::iter
::FusedIterator
;
67 use core
::marker
::{self, Unsize}
;
69 use core
::ops
::{CoerceUnsized, Deref, DerefMut}
;
70 use core
::ops
::{BoxPlace, Boxed, InPlace, Place, Placer}
;
71 use core
::ptr
::{self, Unique}
;
72 use core
::convert
::From
;
73 use str::from_boxed_utf8_unchecked
;
75 /// A value that represents the heap. This is the default place that the `box`
76 /// keyword allocates into when no place is supplied.
78 /// The following two examples are equivalent:
81 /// #![feature(box_heap)]
83 /// #![feature(box_syntax, placement_in_syntax)]
84 /// use std::boxed::HEAP;
87 /// let foo: Box<i32> = in HEAP { 5 };
91 #[unstable(feature = "box_heap",
92 reason
= "may be renamed; uncertain about custom allocator design",
94 pub const HEAP
: ExchangeHeapSingleton
= ExchangeHeapSingleton { _force_singleton: () }
;
96 /// This the singleton type used solely for `boxed::HEAP`.
97 #[unstable(feature = "box_heap",
98 reason
= "may be renamed; uncertain about custom allocator design",
100 #[allow(missing_debug_implementations)]
101 #[derive(Copy, Clone)]
102 pub struct ExchangeHeapSingleton
{
103 _force_singleton
: (),
106 /// A pointer type for heap allocation.
108 /// See the [module-level documentation](../../std/boxed/index.html) for more.
109 #[lang = "owned_box"]
111 #[stable(feature = "rust1", since = "1.0.0")]
112 pub struct Box
<T
: ?Sized
>(Unique
<T
>);
114 /// `IntermediateBox` represents uninitialized backing storage for `Box`.
116 /// FIXME (pnkfelix): Ideally we would just reuse `Box<T>` instead of
117 /// introducing a separate `IntermediateBox<T>`; but then you hit
118 /// issues when you e.g. attempt to destructure an instance of `Box`,
119 /// since it is a lang item and so it gets special handling by the
120 /// compiler. Easier just to make this parallel type for now.
122 /// FIXME (pnkfelix): Currently the `box` protocol only supports
123 /// creating instances of sized types. This IntermediateBox is
124 /// designed to be forward-compatible with a future protocol that
125 /// supports creating instances of unsized types; that is why the type
126 /// parameter has the `?Sized` generalization marker, and is also why
127 /// this carries an explicit size. However, it probably does not need
128 /// to carry the explicit alignment; that is just a work-around for
129 /// the fact that the `align_of` intrinsic currently requires the
130 /// input type to be Sized (which I do not think is strictly
132 #[unstable(feature = "placement_in",
133 reason
= "placement box design is still being worked out.",
135 #[allow(missing_debug_implementations)]
136 pub struct IntermediateBox
<T
: ?Sized
> {
139 marker
: marker
::PhantomData
<*mut T
>,
142 #[unstable(feature = "placement_in",
143 reason
= "placement box design is still being worked out.",
145 impl<T
> Place
<T
> for IntermediateBox
<T
> {
146 fn pointer(&mut self) -> *mut T
{
151 unsafe fn finalize
<T
>(b
: IntermediateBox
<T
>) -> Box
<T
> {
152 let p
= b
.ptr
as *mut T
;
157 fn make_place
<T
>() -> IntermediateBox
<T
> {
158 let layout
= Layout
::new
::<T
>();
160 let p
= if layout
.size() == 0 {
161 mem
::align_of
::<T
>() as *mut u8
164 Heap
.alloc(layout
.clone()).unwrap_or_else(|err
| {
173 marker
: marker
::PhantomData
,
177 #[unstable(feature = "placement_in",
178 reason
= "placement box design is still being worked out.",
180 impl<T
> BoxPlace
<T
> for IntermediateBox
<T
> {
181 fn make_place() -> IntermediateBox
<T
> {
186 #[unstable(feature = "placement_in",
187 reason
= "placement box design is still being worked out.",
189 impl<T
> InPlace
<T
> for IntermediateBox
<T
> {
191 unsafe fn finalize(self) -> Box
<T
> {
196 #[unstable(feature = "placement_new_protocol", issue = "27779")]
197 impl<T
> Boxed
for Box
<T
> {
199 type Place
= IntermediateBox
<T
>;
200 unsafe fn finalize(b
: IntermediateBox
<T
>) -> Box
<T
> {
205 #[unstable(feature = "placement_in",
206 reason
= "placement box design is still being worked out.",
208 impl<T
> Placer
<T
> for ExchangeHeapSingleton
{
209 type Place
= IntermediateBox
<T
>;
211 fn make_place(self) -> IntermediateBox
<T
> {
216 #[unstable(feature = "placement_in",
217 reason
= "placement box design is still being worked out.",
219 impl<T
: ?Sized
> Drop
for IntermediateBox
<T
> {
221 if self.layout
.size() > 0 {
223 Heap
.dealloc(self.ptr
, self.layout
.clone())
230 /// Allocates memory on the heap and then places `x` into it.
232 /// This doesn't actually allocate if `T` is zero-sized.
237 /// let five = Box::new(5);
239 #[stable(feature = "rust1", since = "1.0.0")]
241 pub fn new(x
: T
) -> Box
<T
> {
246 impl<T
: ?Sized
> Box
<T
> {
247 /// Constructs a box from a raw pointer.
249 /// After calling this function, the raw pointer is owned by the
250 /// resulting `Box`. Specifically, the `Box` destructor will call
251 /// the destructor of `T` and free the allocated memory. Since the
252 /// way `Box` allocates and releases memory is unspecified, the
253 /// only valid pointer to pass to this function is the one taken
254 /// from another `Box` via the [`Box::into_raw`] function.
256 /// This function is unsafe because improper use may lead to
257 /// memory problems. For example, a double-free may occur if the
258 /// function is called twice on the same raw pointer.
260 /// [`Box::into_raw`]: struct.Box.html#method.into_raw
265 /// let x = Box::new(5);
266 /// let ptr = Box::into_raw(x);
267 /// let x = unsafe { Box::from_raw(ptr) };
269 #[stable(feature = "box_raw", since = "1.4.0")]
271 pub unsafe fn from_raw(raw
: *mut T
) -> Self {
275 /// Consumes the `Box`, returning the wrapped raw pointer.
277 /// After calling this function, the caller is responsible for the
278 /// memory previously managed by the `Box`. In particular, the
279 /// caller should properly destroy `T` and release the memory. The
280 /// proper way to do so is to convert the raw pointer back into a
281 /// `Box` with the [`Box::from_raw`] function.
283 /// Note: this is an associated function, which means that you have
284 /// to call it as `Box::into_raw(b)` instead of `b.into_raw()`. This
285 /// is so that there is no conflict with a method on the inner type.
287 /// [`Box::from_raw`]: struct.Box.html#method.from_raw
292 /// let x = Box::new(5);
293 /// let ptr = Box::into_raw(x);
295 #[stable(feature = "box_raw", since = "1.4.0")]
297 pub fn into_raw(b
: Box
<T
>) -> *mut T
{
298 unsafe { mem::transmute(b) }
302 #[stable(feature = "rust1", since = "1.0.0")]
303 unsafe impl<#[may_dangle] T: ?Sized> Drop for Box<T> {
305 // FIXME: Do nothing, drop is currently performed by compiler.
309 #[stable(feature = "rust1", since = "1.0.0")]
310 impl<T
: Default
> Default
for Box
<T
> {
311 /// Creates a `Box<T>`, with the `Default` value for T.
312 fn default() -> Box
<T
> {
313 box Default
::default()
317 #[stable(feature = "rust1", since = "1.0.0")]
318 impl<T
> Default
for Box
<[T
]> {
319 fn default() -> Box
<[T
]> {
320 Box
::<[T
; 0]>::new([])
324 #[stable(feature = "default_box_extra", since = "1.17.0")]
325 impl Default
for Box
<str> {
326 fn default() -> Box
<str> {
327 unsafe { from_boxed_utf8_unchecked(Default::default()) }
331 #[stable(feature = "rust1", since = "1.0.0")]
332 impl<T
: Clone
> Clone
for Box
<T
> {
333 /// Returns a new box with a `clone()` of this box's contents.
338 /// let x = Box::new(5);
339 /// let y = x.clone();
343 fn clone(&self) -> Box
<T
> {
344 box { (**self).clone() }
346 /// Copies `source`'s contents into `self` without creating a new allocation.
351 /// let x = Box::new(5);
352 /// let mut y = Box::new(10);
354 /// y.clone_from(&x);
356 /// assert_eq!(*y, 5);
359 fn clone_from(&mut self, source
: &Box
<T
>) {
360 (**self).clone_from(&(**source
));
365 #[stable(feature = "box_slice_clone", since = "1.3.0")]
366 impl Clone
for Box
<str> {
367 fn clone(&self) -> Self {
368 let len
= self.len();
369 let buf
= RawVec
::with_capacity(len
);
371 ptr
::copy_nonoverlapping(self.as_ptr(), buf
.ptr(), len
);
372 from_boxed_utf8_unchecked(buf
.into_box())
377 #[stable(feature = "rust1", since = "1.0.0")]
378 impl<T
: ?Sized
+ PartialEq
> PartialEq
for Box
<T
> {
380 fn eq(&self, other
: &Box
<T
>) -> bool
{
381 PartialEq
::eq(&**self, &**other
)
384 fn ne(&self, other
: &Box
<T
>) -> bool
{
385 PartialEq
::ne(&**self, &**other
)
388 #[stable(feature = "rust1", since = "1.0.0")]
389 impl<T
: ?Sized
+ PartialOrd
> PartialOrd
for Box
<T
> {
391 fn partial_cmp(&self, other
: &Box
<T
>) -> Option
<Ordering
> {
392 PartialOrd
::partial_cmp(&**self, &**other
)
395 fn lt(&self, other
: &Box
<T
>) -> bool
{
396 PartialOrd
::lt(&**self, &**other
)
399 fn le(&self, other
: &Box
<T
>) -> bool
{
400 PartialOrd
::le(&**self, &**other
)
403 fn ge(&self, other
: &Box
<T
>) -> bool
{
404 PartialOrd
::ge(&**self, &**other
)
407 fn gt(&self, other
: &Box
<T
>) -> bool
{
408 PartialOrd
::gt(&**self, &**other
)
411 #[stable(feature = "rust1", since = "1.0.0")]
412 impl<T
: ?Sized
+ Ord
> Ord
for Box
<T
> {
414 fn cmp(&self, other
: &Box
<T
>) -> Ordering
{
415 Ord
::cmp(&**self, &**other
)
418 #[stable(feature = "rust1", since = "1.0.0")]
419 impl<T
: ?Sized
+ Eq
> Eq
for Box
<T
> {}
421 #[stable(feature = "rust1", since = "1.0.0")]
422 impl<T
: ?Sized
+ Hash
> Hash
for Box
<T
> {
423 fn hash
<H
: hash
::Hasher
>(&self, state
: &mut H
) {
424 (**self).hash(state
);
428 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
429 impl<T
> From
<T
> for Box
<T
> {
430 fn from(t
: T
) -> Self {
435 #[stable(feature = "box_from_slice", since = "1.17.0")]
436 impl<'a
, T
: Copy
> From
<&'a
[T
]> for Box
<[T
]> {
437 fn from(slice
: &'a
[T
]) -> Box
<[T
]> {
438 let mut boxed
= unsafe { RawVec::with_capacity(slice.len()).into_box() }
;
439 boxed
.copy_from_slice(slice
);
444 #[stable(feature = "box_from_slice", since = "1.17.0")]
445 impl<'a
> From
<&'a
str> for Box
<str> {
446 fn from(s
: &'a
str) -> Box
<str> {
447 unsafe { from_boxed_utf8_unchecked(Box::from(s.as_bytes())) }
451 #[stable(feature = "boxed_str_conv", since = "1.19.0")]
452 impl From
<Box
<str>> for Box
<[u8]> {
453 fn from(s
: Box
<str>) -> Self {
462 #[stable(feature = "rust1", since = "1.0.0")]
463 /// Attempt to downcast the box to a concrete type.
468 /// use std::any::Any;
470 /// fn print_if_string(value: Box<Any>) {
471 /// if let Ok(string) = value.downcast::<String>() {
472 /// println!("String ({}): {}", string.len(), string);
477 /// let my_string = "Hello World".to_string();
478 /// print_if_string(Box::new(my_string));
479 /// print_if_string(Box::new(0i8));
482 pub fn downcast
<T
: Any
>(self) -> Result
<Box
<T
>, Box
<Any
>> {
485 let raw
: *mut Any
= Box
::into_raw(self);
486 Ok(Box
::from_raw(raw
as *mut T
))
494 impl Box
<Any
+ Send
> {
496 #[stable(feature = "rust1", since = "1.0.0")]
497 /// Attempt to downcast the box to a concrete type.
502 /// use std::any::Any;
504 /// fn print_if_string(value: Box<Any + Send>) {
505 /// if let Ok(string) = value.downcast::<String>() {
506 /// println!("String ({}): {}", string.len(), string);
511 /// let my_string = "Hello World".to_string();
512 /// print_if_string(Box::new(my_string));
513 /// print_if_string(Box::new(0i8));
516 pub fn downcast
<T
: Any
>(self) -> Result
<Box
<T
>, Box
<Any
+ Send
>> {
517 <Box
<Any
>>::downcast(self).map_err(|s
| unsafe {
518 // reapply the Send marker
519 mem
::transmute
::<Box
<Any
>, Box
<Any
+ Send
>>(s
)
524 #[stable(feature = "rust1", since = "1.0.0")]
525 impl<T
: fmt
::Display
+ ?Sized
> fmt
::Display
for Box
<T
> {
526 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
527 fmt
::Display
::fmt(&**self, f
)
531 #[stable(feature = "rust1", since = "1.0.0")]
532 impl<T
: fmt
::Debug
+ ?Sized
> fmt
::Debug
for Box
<T
> {
533 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
534 fmt
::Debug
::fmt(&**self, f
)
538 #[stable(feature = "rust1", since = "1.0.0")]
539 impl<T
: ?Sized
> fmt
::Pointer
for Box
<T
> {
540 fn fmt(&self, f
: &mut fmt
::Formatter
) -> fmt
::Result
{
541 // It's not possible to extract the inner Uniq directly from the Box,
542 // instead we cast it to a *const which aliases the Unique
543 let ptr
: *const T
= &**self;
544 fmt
::Pointer
::fmt(&ptr
, f
)
548 #[stable(feature = "rust1", since = "1.0.0")]
549 impl<T
: ?Sized
> Deref
for Box
<T
> {
552 fn deref(&self) -> &T
{
557 #[stable(feature = "rust1", since = "1.0.0")]
558 impl<T
: ?Sized
> DerefMut
for Box
<T
> {
559 fn deref_mut(&mut self) -> &mut T
{
564 #[stable(feature = "rust1", since = "1.0.0")]
565 impl<I
: Iterator
+ ?Sized
> Iterator
for Box
<I
> {
567 fn next(&mut self) -> Option
<I
::Item
> {
570 fn size_hint(&self) -> (usize, Option
<usize>) {
573 fn nth(&mut self, n
: usize) -> Option
<I
::Item
> {
577 #[stable(feature = "rust1", since = "1.0.0")]
578 impl<I
: DoubleEndedIterator
+ ?Sized
> DoubleEndedIterator
for Box
<I
> {
579 fn next_back(&mut self) -> Option
<I
::Item
> {
583 #[stable(feature = "rust1", since = "1.0.0")]
584 impl<I
: ExactSizeIterator
+ ?Sized
> ExactSizeIterator
for Box
<I
> {
585 fn len(&self) -> usize {
588 fn is_empty(&self) -> bool
{
593 #[unstable(feature = "fused", issue = "35602")]
594 impl<I
: FusedIterator
+ ?Sized
> FusedIterator
for Box
<I
> {}
597 /// `FnBox` is a version of the `FnOnce` intended for use with boxed
598 /// closure objects. The idea is that where one would normally store a
599 /// `Box<FnOnce()>` in a data structure, you should use
600 /// `Box<FnBox()>`. The two traits behave essentially the same, except
601 /// that a `FnBox` closure can only be called if it is boxed. (Note
602 /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
603 /// closures become directly usable.)
607 /// Here is a snippet of code which creates a hashmap full of boxed
608 /// once closures and then removes them one by one, calling each
609 /// closure as it is removed. Note that the type of the closures
610 /// stored in the map is `Box<FnBox() -> i32>` and not `Box<FnOnce()
614 /// #![feature(fnbox)]
616 /// use std::boxed::FnBox;
617 /// use std::collections::HashMap;
619 /// fn make_map() -> HashMap<i32, Box<FnBox() -> i32>> {
620 /// let mut map: HashMap<i32, Box<FnBox() -> i32>> = HashMap::new();
621 /// map.insert(1, Box::new(|| 22));
622 /// map.insert(2, Box::new(|| 44));
627 /// let mut map = make_map();
628 /// for i in &[1, 2] {
629 /// let f = map.remove(&i).unwrap();
630 /// assert_eq!(f(), i * 22);
635 #[unstable(feature = "fnbox",
636 reason
= "will be deprecated if and when `Box<FnOnce>` becomes usable", issue
= "28796")]
640 fn call_box(self: Box
<Self>, args
: A
) -> Self::Output
;
643 #[unstable(feature = "fnbox",
644 reason
= "will be deprecated if and when `Box<FnOnce>` becomes usable", issue
= "28796")]
645 impl<A
, F
> FnBox
<A
> for F
648 type Output
= F
::Output
;
650 fn call_box(self: Box
<F
>, args
: A
) -> F
::Output
{
655 #[unstable(feature = "fnbox",
656 reason
= "will be deprecated if and when `Box<FnOnce>` becomes usable", issue
= "28796")]
657 impl<'a
, A
, R
> FnOnce
<A
> for Box
<FnBox
<A
, Output
= R
> + 'a
> {
660 extern "rust-call" fn call_once(self, args
: A
) -> R
{
665 #[unstable(feature = "fnbox",
666 reason
= "will be deprecated if and when `Box<FnOnce>` becomes usable", issue
= "28796")]
667 impl<'a
, A
, R
> FnOnce
<A
> for Box
<FnBox
<A
, Output
= R
> + Send
+ 'a
> {
670 extern "rust-call" fn call_once(self, args
: A
) -> R
{
675 #[unstable(feature = "coerce_unsized", issue = "27732")]
676 impl<T
: ?Sized
+ Unsize
<U
>, U
: ?Sized
> CoerceUnsized
<Box
<U
>> for Box
<T
> {}
678 #[stable(feature = "box_slice_clone", since = "1.3.0")]
679 impl<T
: Clone
> Clone
for Box
<[T
]> {
680 fn clone(&self) -> Self {
681 let mut new
= BoxBuilder
{
682 data
: RawVec
::with_capacity(self.len()),
686 let mut target
= new
.data
.ptr();
688 for item
in self.iter() {
690 ptr
::write(target
, item
.clone());
691 target
= target
.offset(1);
697 return unsafe { new.into_box() }
;
699 // Helper type for responding to panics correctly.
700 struct BoxBuilder
<T
> {
705 impl<T
> BoxBuilder
<T
> {
706 unsafe fn into_box(self) -> Box
<[T
]> {
707 let raw
= ptr
::read(&self.data
);
713 impl<T
> Drop
for BoxBuilder
<T
> {
715 let mut data
= self.data
.ptr();
716 let max
= unsafe { data.offset(self.len as isize) }
;
721 data
= data
.offset(1);
729 #[stable(feature = "box_borrow", since = "1.1.0")]
730 impl<T
: ?Sized
> borrow
::Borrow
<T
> for Box
<T
> {
731 fn borrow(&self) -> &T
{
736 #[stable(feature = "box_borrow", since = "1.1.0")]
737 impl<T
: ?Sized
> borrow
::BorrowMut
<T
> for Box
<T
> {
738 fn borrow_mut(&mut self) -> &mut T
{
743 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
744 impl<T
: ?Sized
> AsRef
<T
> for Box
<T
> {
745 fn as_ref(&self) -> &T
{
750 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
751 impl<T
: ?Sized
> AsMut
<T
> for Box
<T
> {
752 fn as_mut(&mut self) -> &mut T
{