src/liballoc/boxed.rs

   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.
   4 //
   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.
  10
  11 //! A pointer type for heap allocation.
  12 //!
  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.
  16 //!
  17 //! # Examples
  18 //!
  19 //! Creating a box:
  20 //!
  21 //! ```
  22 //! let x = Box::new(5);
  23 //! ```
  24 //!
  25 //! Creating a recursive data structure:
  26 //!
  27 //! ```
  28 //! #[derive(Debug)]
  29 //! enum List<T> {
  30 //!     Cons(T, Box<List<T>>),
  31 //!     Nil,
  32 //! }
  33 //!
  34 //! fn main() {
  35 //!     let list: List<i32> = List::Cons(1, Box::new(List::Cons(2, Box::new(List::Nil))));
  36 //!     println!("{:?}", list);
  37 //! }
  38 //! ```
  39 //!
  40 //! This will print `Cons(1, Cons(2, Nil))`.
  41 //!
  42 //! Recursive structures must be boxed, because if the definition of `Cons`
  43 //! looked like this:
  44 //!
  45 //! ```compile_fail,E0072
  46 //! # enum List<T> {
  47 //! Cons(T, List<T>),
  48 //! # }
  49 //! ```
  50 //!
  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.
  55
  56 #![stable(feature = "rust1", since = "1.0.0")]
  57
  58 use heap::{Heap, Layout, Alloc};
  59 use raw_vec::RawVec;
  60
  61 use core::any::Any;
  62 use core::borrow;
  63 use core::cmp::Ordering;
  64 use core::fmt;
  65 use core::hash::{self, Hash, Hasher};
  66 use core::iter::FusedIterator;
  67 use core::marker::{self, Unsize};
  68 use core::mem;
  69 use core::ops::{CoerceUnsized, Deref, DerefMut, Generator, GeneratorState};
  70 use core::ops::{BoxPlace, Boxed, InPlace, Place, Placer};
  71 use core::ptr::{self, NonNull, Unique};
  72 use core::convert::From;
  73 use str::from_boxed_utf8_unchecked;
  74
  75 /// A value that represents the heap. This is the default place that the `box`
  76 /// keyword allocates into when no place is supplied.
  77 ///
  78 /// The following two examples are equivalent:
  79 ///
  80 /// ```
  81 /// #![feature(box_heap)]
  82 ///
  83 /// #![feature(box_syntax, placement_in_syntax)]
  84 /// use std::boxed::HEAP;
  85 ///
  86 /// fn main() {
  87 ///     let foo: Box<i32> = in HEAP { 5 };
  88 ///     let foo = box 5;
  89 /// }
  90 /// ```
  91 #[unstable(feature = "box_heap",
  92            reason = "may be renamed; uncertain about custom allocator design",
  93            issue = "27779")]
  94 pub const HEAP: ExchangeHeapSingleton = ExchangeHeapSingleton { _force_singleton: () };
  95
  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",
  99            issue = "27779")]
 100 #[allow(missing_debug_implementations)]
 101 #[derive(Copy, Clone)]
 102 pub struct ExchangeHeapSingleton {
 103     _force_singleton: (),
 104 }
 105
 106 /// A pointer type for heap allocation.
 107 ///
 108 /// See the [module-level documentation](../../std/boxed/index.html) for more.
 109 #[lang = "owned_box"]
 110 #[fundamental]
 111 #[stable(feature = "rust1", since = "1.0.0")]
 112 pub struct Box<T: ?Sized>(Unique<T>);
 113
 114 /// `IntermediateBox` represents uninitialized backing storage for `Box`.
 115 ///
 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.
 121 ///
 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
 131 /// necessary).
 132 #[unstable(feature = "placement_in",
 133            reason = "placement box design is still being worked out.",
 134            issue = "27779")]
 135 #[allow(missing_debug_implementations)]
 136 pub struct IntermediateBox<T: ?Sized> {
 137     ptr: *mut u8,
 138     layout: Layout,
 139     marker: marker::PhantomData<*mut T>,
 140 }
 141
 142 #[unstable(feature = "placement_in",
 143            reason = "placement box design is still being worked out.",
 144            issue = "27779")]
 145 unsafe impl<T> Place<T> for IntermediateBox<T> {
 146     fn pointer(&mut self) -> *mut T {
 147         self.ptr as *mut T
 148     }
 149 }
 150
 151 unsafe fn finalize<T>(b: IntermediateBox<T>) -> Box<T> {
 152     let p = b.ptr as *mut T;
 153     mem::forget(b);
 154     Box::from_raw(p)
 155 }
 156
 157 fn make_place<T>() -> IntermediateBox<T> {
 158     let layout = Layout::new::<T>();
 159
 160     let p = if layout.size() == 0 {
 161         mem::align_of::<T>() as *mut u8
 162     } else {
 163         unsafe {
 164             Heap.alloc(layout.clone()).unwrap_or_else(|err| {
 165                 Heap.oom(err)
 166             })
 167         }
 168     };
 169
 170     IntermediateBox {
 171         ptr: p,
 172         layout,
 173         marker: marker::PhantomData,
 174     }
 175 }
 176
 177 #[unstable(feature = "placement_in",
 178            reason = "placement box design is still being worked out.",
 179            issue = "27779")]
 180 impl<T> BoxPlace<T> for IntermediateBox<T> {
 181     fn make_place() -> IntermediateBox<T> {
 182         make_place()
 183     }
 184 }
 185
 186 #[unstable(feature = "placement_in",
 187            reason = "placement box design is still being worked out.",
 188            issue = "27779")]
 189 impl<T> InPlace<T> for IntermediateBox<T> {
 190     type Owner = Box<T>;
 191     unsafe fn finalize(self) -> Box<T> {
 192         finalize(self)
 193     }
 194 }
 195
 196 #[unstable(feature = "placement_new_protocol", issue = "27779")]
 197 impl<T> Boxed for Box<T> {
 198     type Data = T;
 199     type Place = IntermediateBox<T>;
 200     unsafe fn finalize(b: IntermediateBox<T>) -> Box<T> {
 201         finalize(b)
 202     }
 203 }
 204
 205 #[unstable(feature = "placement_in",
 206            reason = "placement box design is still being worked out.",
 207            issue = "27779")]
 208 impl<T> Placer<T> for ExchangeHeapSingleton {
 209     type Place = IntermediateBox<T>;
 210
 211     fn make_place(self) -> IntermediateBox<T> {
 212         make_place()
 213     }
 214 }
 215
 216 #[unstable(feature = "placement_in",
 217            reason = "placement box design is still being worked out.",
 218            issue = "27779")]
 219 impl<T: ?Sized> Drop for IntermediateBox<T> {
 220     fn drop(&mut self) {
 221         if self.layout.size() > 0 {
 222             unsafe {
 223                 Heap.dealloc(self.ptr, self.layout.clone())
 224             }
 225         }
 226     }
 227 }
 228
 229 impl<T> Box<T> {
 230     /// Allocates memory on the heap and then places `x` into it.
 231     ///
 232     /// This doesn't actually allocate if `T` is zero-sized.
 233     ///
 234     /// # Examples
 235     ///
 236     /// ```
 237     /// let five = Box::new(5);
 238     /// ```
 239     #[stable(feature = "rust1", since = "1.0.0")]
 240     #[inline(always)]
 241     pub fn new(x: T) -> Box<T> {
 242         box x
 243     }
 244 }
 245
 246 impl<T: ?Sized> Box<T> {
 247     /// Constructs a box from a raw pointer.
 248     ///
 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.
 255     ///
 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.
 259     ///
 260     /// [`Box::into_raw`]: struct.Box.html#method.into_raw
 261     ///
 262     /// # Examples
 263     ///
 264     /// ```
 265     /// let x = Box::new(5);
 266     /// let ptr = Box::into_raw(x);
 267     /// let x = unsafe { Box::from_raw(ptr) };
 268     /// ```
 269     #[stable(feature = "box_raw", since = "1.4.0")]
 270     #[inline]
 271     pub unsafe fn from_raw(raw: *mut T) -> Self {
 272         Box(Unique::new_unchecked(raw))
 273     }
 274
 275     /// Consumes the `Box`, returning the wrapped raw pointer.
 276     ///
 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.
 282     ///
 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.
 286     ///
 287     /// [`Box::from_raw`]: struct.Box.html#method.from_raw
 288     ///
 289     /// # Examples
 290     ///
 291     /// ```
 292     /// let x = Box::new(5);
 293     /// let ptr = Box::into_raw(x);
 294     /// ```
 295     #[stable(feature = "box_raw", since = "1.4.0")]
 296     #[inline]
 297     pub fn into_raw(b: Box<T>) -> *mut T {
 298         Box::into_raw_non_null(b).as_ptr()
 299     }
 300
 301     /// Consumes the `Box`, returning the wrapped pointer as `NonNull<T>`.
 302     ///
 303     /// After calling this function, the caller is responsible for the
 304     /// memory previously managed by the `Box`. In particular, the
 305     /// caller should properly destroy `T` and release the memory. The
 306     /// proper way to do so is to convert the `NonNull<T>` pointer
 307     /// into a raw pointer and back into a `Box` with the [`Box::from_raw`]
 308     /// function.
 309     ///
 310     /// Note: this is an associated function, which means that you have
 311     /// to call it as `Box::into_raw_non_null(b)`
 312     /// instead of `b.into_raw_non_null()`. This
 313     /// is so that there is no conflict with a method on the inner type.
 314     ///
 315     /// [`Box::from_raw`]: struct.Box.html#method.from_raw
 316     ///
 317     /// # Examples
 318     ///
 319     /// ```
 320     /// #![feature(box_into_raw_non_null)]
 321     ///
 322     /// fn main() {
 323     ///     let x = Box::new(5);
 324     ///     let ptr = Box::into_raw_non_null(x);
 325     /// }
 326     /// ```
 327     #[unstable(feature = "box_into_raw_non_null", issue = "47336")]
 328     #[inline]
 329     pub fn into_raw_non_null(b: Box<T>) -> NonNull<T> {
 330         Box::into_unique(b).into()
 331     }
 332
 333     #[unstable(feature = "ptr_internals", issue = "0", reason = "use into_raw_non_null instead")]
 334     #[inline]
 335     pub fn into_unique(b: Box<T>) -> Unique<T> {
 336         let unique = b.0;
 337         mem::forget(b);
 338         unique
 339     }
 340
 341     /// Consumes and leaks the `Box`, returning a mutable reference,
 342     /// `&'a mut T`. Here, the lifetime `'a` may be chosen to be `'static`.
 343     ///
 344     /// This function is mainly useful for data that lives for the remainder of
 345     /// the program's life. Dropping the returned reference will cause a memory
 346     /// leak. If this is not acceptable, the reference should first be wrapped
 347     /// with the [`Box::from_raw`] function producing a `Box`. This `Box` can
 348     /// then be dropped which will properly destroy `T` and release the
 349     /// allocated memory.
 350     ///
 351     /// Note: this is an associated function, which means that you have
 352     /// to call it as `Box::leak(b)` instead of `b.leak()`. This
 353     /// is so that there is no conflict with a method on the inner type.
 354     ///
 355     /// [`Box::from_raw`]: struct.Box.html#method.from_raw
 356     ///
 357     /// # Examples
 358     ///
 359     /// Simple usage:
 360     ///
 361     /// ```
 362     /// fn main() {
 363     ///     let x = Box::new(41);
 364     ///     let static_ref: &'static mut usize = Box::leak(x);
 365     ///     *static_ref += 1;
 366     ///     assert_eq!(*static_ref, 42);
 367     /// }
 368     /// ```
 369     ///
 370     /// Unsized data:
 371     ///
 372     /// ```
 373     /// fn main() {
 374     ///     let x = vec![1, 2, 3].into_boxed_slice();
 375     ///     let static_ref = Box::leak(x);
 376     ///     static_ref[0] = 4;
 377     ///     assert_eq!(*static_ref, [4, 2, 3]);
 378     /// }
 379     /// ```
 380     #[stable(feature = "box_leak", since = "1.26.0")]
 381     #[inline]
 382     pub fn leak<'a>(b: Box<T>) -> &'a mut T
 383     where
 384         T: 'a // Technically not needed, but kept to be explicit.
 385     {
 386         unsafe { &mut *Box::into_raw(b) }
 387     }
 388 }
 389
 390 #[stable(feature = "rust1", since = "1.0.0")]
 391 unsafe impl<#[may_dangle] T: ?Sized> Drop for Box<T> {
 392     fn drop(&mut self) {
 393         // FIXME: Do nothing, drop is currently performed by compiler.
 394     }
 395 }
 396
 397 #[stable(feature = "rust1", since = "1.0.0")]
 398 impl<T: Default> Default for Box<T> {
 399     /// Creates a `Box<T>`, with the `Default` value for T.
 400     fn default() -> Box<T> {
 401         box Default::default()
 402     }
 403 }
 404
 405 #[stable(feature = "rust1", since = "1.0.0")]
 406 impl<T> Default for Box<[T]> {
 407     fn default() -> Box<[T]> {
 408         Box::<[T; 0]>::new([])
 409     }
 410 }
 411
 412 #[stable(feature = "default_box_extra", since = "1.17.0")]
 413 impl Default for Box<str> {
 414     fn default() -> Box<str> {
 415         unsafe { from_boxed_utf8_unchecked(Default::default()) }
 416     }
 417 }
 418
 419 #[stable(feature = "rust1", since = "1.0.0")]
 420 impl<T: Clone> Clone for Box<T> {
 421     /// Returns a new box with a `clone()` of this box's contents.
 422     ///
 423     /// # Examples
 424     ///
 425     /// ```
 426     /// let x = Box::new(5);
 427     /// let y = x.clone();
 428     /// ```
 429     #[rustfmt_skip]
 430     #[inline]
 431     fn clone(&self) -> Box<T> {
 432         box { (**self).clone() }
 433     }
 434     /// Copies `source`'s contents into `self` without creating a new allocation.
 435     ///
 436     /// # Examples
 437     ///
 438     /// ```
 439     /// let x = Box::new(5);
 440     /// let mut y = Box::new(10);
 441     ///
 442     /// y.clone_from(&x);
 443     ///
 444     /// assert_eq!(*y, 5);
 445     /// ```
 446     #[inline]
 447     fn clone_from(&mut self, source: &Box<T>) {
 448         (**self).clone_from(&(**source));
 449     }
 450 }
 451
 452
 453 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 454 impl Clone for Box<str> {
 455     fn clone(&self) -> Self {
 456         let len = self.len();
 457         let buf = RawVec::with_capacity(len);
 458         unsafe {
 459             ptr::copy_nonoverlapping(self.as_ptr(), buf.ptr(), len);
 460             from_boxed_utf8_unchecked(buf.into_box())
 461         }
 462     }
 463 }
 464
 465 #[stable(feature = "rust1", since = "1.0.0")]
 466 impl<T: ?Sized + PartialEq> PartialEq for Box<T> {
 467     #[inline]
 468     fn eq(&self, other: &Box<T>) -> bool {
 469         PartialEq::eq(&**self, &**other)
 470     }
 471     #[inline]
 472     fn ne(&self, other: &Box<T>) -> bool {
 473         PartialEq::ne(&**self, &**other)
 474     }
 475 }
 476 #[stable(feature = "rust1", since = "1.0.0")]
 477 impl<T: ?Sized + PartialOrd> PartialOrd for Box<T> {
 478     #[inline]
 479     fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering> {
 480         PartialOrd::partial_cmp(&**self, &**other)
 481     }
 482     #[inline]
 483     fn lt(&self, other: &Box<T>) -> bool {
 484         PartialOrd::lt(&**self, &**other)
 485     }
 486     #[inline]
 487     fn le(&self, other: &Box<T>) -> bool {
 488         PartialOrd::le(&**self, &**other)
 489     }
 490     #[inline]
 491     fn ge(&self, other: &Box<T>) -> bool {
 492         PartialOrd::ge(&**self, &**other)
 493     }
 494     #[inline]
 495     fn gt(&self, other: &Box<T>) -> bool {
 496         PartialOrd::gt(&**self, &**other)
 497     }
 498 }
 499 #[stable(feature = "rust1", since = "1.0.0")]
 500 impl<T: ?Sized + Ord> Ord for Box<T> {
 501     #[inline]
 502     fn cmp(&self, other: &Box<T>) -> Ordering {
 503         Ord::cmp(&**self, &**other)
 504     }
 505 }
 506 #[stable(feature = "rust1", since = "1.0.0")]
 507 impl<T: ?Sized + Eq> Eq for Box<T> {}
 508
 509 #[stable(feature = "rust1", since = "1.0.0")]
 510 impl<T: ?Sized + Hash> Hash for Box<T> {
 511     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 512         (**self).hash(state);
 513     }
 514 }
 515
 516 #[stable(feature = "indirect_hasher_impl", since = "1.22.0")]
 517 impl<T: ?Sized + Hasher> Hasher for Box<T> {
 518     fn finish(&self) -> u64 {
 519         (**self).finish()
 520     }
 521     fn write(&mut self, bytes: &[u8]) {
 522         (**self).write(bytes)
 523     }
 524     fn write_u8(&mut self, i: u8) {
 525         (**self).write_u8(i)
 526     }
 527     fn write_u16(&mut self, i: u16) {
 528         (**self).write_u16(i)
 529     }
 530     fn write_u32(&mut self, i: u32) {
 531         (**self).write_u32(i)
 532     }
 533     fn write_u64(&mut self, i: u64) {
 534         (**self).write_u64(i)
 535     }
 536     fn write_u128(&mut self, i: u128) {
 537         (**self).write_u128(i)
 538     }
 539     fn write_usize(&mut self, i: usize) {
 540         (**self).write_usize(i)
 541     }
 542     fn write_i8(&mut self, i: i8) {
 543         (**self).write_i8(i)
 544     }
 545     fn write_i16(&mut self, i: i16) {
 546         (**self).write_i16(i)
 547     }
 548     fn write_i32(&mut self, i: i32) {
 549         (**self).write_i32(i)
 550     }
 551     fn write_i64(&mut self, i: i64) {
 552         (**self).write_i64(i)
 553     }
 554     fn write_i128(&mut self, i: i128) {
 555         (**self).write_i128(i)
 556     }
 557     fn write_isize(&mut self, i: isize) {
 558         (**self).write_isize(i)
 559     }
 560 }
 561
 562 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
 563 impl<T> From<T> for Box<T> {
 564     fn from(t: T) -> Self {
 565         Box::new(t)
 566     }
 567 }
 568
 569 #[stable(feature = "box_from_slice", since = "1.17.0")]
 570 impl<'a, T: Copy> From<&'a [T]> for Box<[T]> {
 571     fn from(slice: &'a [T]) -> Box<[T]> {
 572         let mut boxed = unsafe { RawVec::with_capacity(slice.len()).into_box() };
 573         boxed.copy_from_slice(slice);
 574         boxed
 575     }
 576 }
 577
 578 #[stable(feature = "box_from_slice", since = "1.17.0")]
 579 impl<'a> From<&'a str> for Box<str> {
 580     fn from(s: &'a str) -> Box<str> {
 581         unsafe { from_boxed_utf8_unchecked(Box::from(s.as_bytes())) }
 582     }
 583 }
 584
 585 #[stable(feature = "boxed_str_conv", since = "1.19.0")]
 586 impl From<Box<str>> for Box<[u8]> {
 587     fn from(s: Box<str>) -> Self {
 588         unsafe { Box::from_raw(Box::into_raw(s) as *mut [u8]) }
 589     }
 590 }
 591
 592 impl Box<Any> {
 593     #[inline]
 594     #[stable(feature = "rust1", since = "1.0.0")]
 595     /// Attempt to downcast the box to a concrete type.
 596     ///
 597     /// # Examples
 598     ///
 599     /// ```
 600     /// use std::any::Any;
 601     ///
 602     /// fn print_if_string(value: Box<Any>) {
 603     ///     if let Ok(string) = value.downcast::<String>() {
 604     ///         println!("String ({}): {}", string.len(), string);
 605     ///     }
 606     /// }
 607     ///
 608     /// fn main() {
 609     ///     let my_string = "Hello World".to_string();
 610     ///     print_if_string(Box::new(my_string));
 611     ///     print_if_string(Box::new(0i8));
 612     /// }
 613     /// ```
 614     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any>> {
 615         if self.is::<T>() {
 616             unsafe {
 617                 let raw: *mut Any = Box::into_raw(self);
 618                 Ok(Box::from_raw(raw as *mut T))
 619             }
 620         } else {
 621             Err(self)
 622         }
 623     }
 624 }
 625
 626 impl Box<Any + Send> {
 627     #[inline]
 628     #[stable(feature = "rust1", since = "1.0.0")]
 629     /// Attempt to downcast the box to a concrete type.
 630     ///
 631     /// # Examples
 632     ///
 633     /// ```
 634     /// use std::any::Any;
 635     ///
 636     /// fn print_if_string(value: Box<Any + Send>) {
 637     ///     if let Ok(string) = value.downcast::<String>() {
 638     ///         println!("String ({}): {}", string.len(), string);
 639     ///     }
 640     /// }
 641     ///
 642     /// fn main() {
 643     ///     let my_string = "Hello World".to_string();
 644     ///     print_if_string(Box::new(my_string));
 645     ///     print_if_string(Box::new(0i8));
 646     /// }
 647     /// ```
 648     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any + Send>> {
 649         <Box<Any>>::downcast(self).map_err(|s| unsafe {
 650             // reapply the Send marker
 651             Box::from_raw(Box::into_raw(s) as *mut (Any + Send))
 652         })
 653     }
 654 }
 655
 656 #[stable(feature = "rust1", since = "1.0.0")]
 657 impl<T: fmt::Display + ?Sized> fmt::Display for Box<T> {
 658     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 659         fmt::Display::fmt(&**self, f)
 660     }
 661 }
 662
 663 #[stable(feature = "rust1", since = "1.0.0")]
 664 impl<T: fmt::Debug + ?Sized> fmt::Debug for Box<T> {
 665     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 666         fmt::Debug::fmt(&**self, f)
 667     }
 668 }
 669
 670 #[stable(feature = "rust1", since = "1.0.0")]
 671 impl<T: ?Sized> fmt::Pointer for Box<T> {
 672     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 673         // It's not possible to extract the inner Uniq directly from the Box,
 674         // instead we cast it to a *const which aliases the Unique
 675         let ptr: *const T = &**self;
 676         fmt::Pointer::fmt(&ptr, f)
 677     }
 678 }
 679
 680 #[stable(feature = "rust1", since = "1.0.0")]
 681 impl<T: ?Sized> Deref for Box<T> {
 682     type Target = T;
 683
 684     fn deref(&self) -> &T {
 685         &**self
 686     }
 687 }
 688
 689 #[stable(feature = "rust1", since = "1.0.0")]
 690 impl<T: ?Sized> DerefMut for Box<T> {
 691     fn deref_mut(&mut self) -> &mut T {
 692         &mut **self
 693     }
 694 }
 695
 696 #[stable(feature = "rust1", since = "1.0.0")]
 697 impl<I: Iterator + ?Sized> Iterator for Box<I> {
 698     type Item = I::Item;
 699     fn next(&mut self) -> Option<I::Item> {
 700         (**self).next()
 701     }
 702     fn size_hint(&self) -> (usize, Option<usize>) {
 703         (**self).size_hint()
 704     }
 705     fn nth(&mut self, n: usize) -> Option<I::Item> {
 706         (**self).nth(n)
 707     }
 708 }
 709 #[stable(feature = "rust1", since = "1.0.0")]
 710 impl<I: DoubleEndedIterator + ?Sized> DoubleEndedIterator for Box<I> {
 711     fn next_back(&mut self) -> Option<I::Item> {
 712         (**self).next_back()
 713     }
 714 }
 715 #[stable(feature = "rust1", since = "1.0.0")]
 716 impl<I: ExactSizeIterator + ?Sized> ExactSizeIterator for Box<I> {
 717     fn len(&self) -> usize {
 718         (**self).len()
 719     }
 720     fn is_empty(&self) -> bool {
 721         (**self).is_empty()
 722     }
 723 }
 724
 725 #[unstable(feature = "fused", issue = "35602")]
 726 impl<I: FusedIterator + ?Sized> FusedIterator for Box<I> {}
 727
 728
 729 /// `FnBox` is a version of the `FnOnce` intended for use with boxed
 730 /// closure objects. The idea is that where one would normally store a
 731 /// `Box<FnOnce()>` in a data structure, you should use
 732 /// `Box<FnBox()>`. The two traits behave essentially the same, except
 733 /// that a `FnBox` closure can only be called if it is boxed. (Note
 734 /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
 735 /// closures become directly usable.)
 736 ///
 737 /// # Examples
 738 ///
 739 /// Here is a snippet of code which creates a hashmap full of boxed
 740 /// once closures and then removes them one by one, calling each
 741 /// closure as it is removed. Note that the type of the closures
 742 /// stored in the map is `Box<FnBox() -> i32>` and not `Box<FnOnce()
 743 /// -> i32>`.
 744 ///
 745 /// ```
 746 /// #![feature(fnbox)]
 747 ///
 748 /// use std::boxed::FnBox;
 749 /// use std::collections::HashMap;
 750 ///
 751 /// fn make_map() -> HashMap<i32, Box<FnBox() -> i32>> {
 752 ///     let mut map: HashMap<i32, Box<FnBox() -> i32>> = HashMap::new();
 753 ///     map.insert(1, Box::new(|| 22));
 754 ///     map.insert(2, Box::new(|| 44));
 755 ///     map
 756 /// }
 757 ///
 758 /// fn main() {
 759 ///     let mut map = make_map();
 760 ///     for i in &[1, 2] {
 761 ///         let f = map.remove(&i).unwrap();
 762 ///         assert_eq!(f(), i * 22);
 763 ///     }
 764 /// }
 765 /// ```
 766 #[rustc_paren_sugar]
 767 #[unstable(feature = "fnbox",
 768            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 769 pub trait FnBox<A> {
 770     type Output;
 771
 772     fn call_box(self: Box<Self>, args: A) -> Self::Output;
 773 }
 774
 775 #[unstable(feature = "fnbox",
 776            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 777 impl<A, F> FnBox<A> for F
 778     where F: FnOnce<A>
 779 {
 780     type Output = F::Output;
 781
 782     fn call_box(self: Box<F>, args: A) -> F::Output {
 783         self.call_once(args)
 784     }
 785 }
 786
 787 #[unstable(feature = "fnbox",
 788            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 789 impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + 'a> {
 790     type Output = R;
 791
 792     extern "rust-call" fn call_once(self, args: A) -> R {
 793         self.call_box(args)
 794     }
 795 }
 796
 797 #[unstable(feature = "fnbox",
 798            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 799 impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + Send + 'a> {
 800     type Output = R;
 801
 802     extern "rust-call" fn call_once(self, args: A) -> R {
 803         self.call_box(args)
 804     }
 805 }
 806
 807 #[unstable(feature = "coerce_unsized", issue = "27732")]
 808 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Box<U>> for Box<T> {}
 809
 810 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 811 impl<T: Clone> Clone for Box<[T]> {
 812     fn clone(&self) -> Self {
 813         let mut new = BoxBuilder {
 814             data: RawVec::with_capacity(self.len()),
 815             len: 0,
 816         };
 817
 818         let mut target = new.data.ptr();
 819
 820         for item in self.iter() {
 821             unsafe {
 822                 ptr::write(target, item.clone());
 823                 target = target.offset(1);
 824             };
 825
 826             new.len += 1;
 827         }
 828
 829         return unsafe { new.into_box() };
 830
 831         // Helper type for responding to panics correctly.
 832         struct BoxBuilder<T> {
 833             data: RawVec<T>,
 834             len: usize,
 835         }
 836
 837         impl<T> BoxBuilder<T> {
 838             unsafe fn into_box(self) -> Box<[T]> {
 839                 let raw = ptr::read(&self.data);
 840                 mem::forget(self);
 841                 raw.into_box()
 842             }
 843         }
 844
 845         impl<T> Drop for BoxBuilder<T> {
 846             fn drop(&mut self) {
 847                 let mut data = self.data.ptr();
 848                 let max = unsafe { data.offset(self.len as isize) };
 849
 850                 while data != max {
 851                     unsafe {
 852                         ptr::read(data);
 853                         data = data.offset(1);
 854                     }
 855                 }
 856             }
 857         }
 858     }
 859 }
 860
 861 #[stable(feature = "box_borrow", since = "1.1.0")]
 862 impl<T: ?Sized> borrow::Borrow<T> for Box<T> {
 863     fn borrow(&self) -> &T {
 864         &**self
 865     }
 866 }
 867
 868 #[stable(feature = "box_borrow", since = "1.1.0")]
 869 impl<T: ?Sized> borrow::BorrowMut<T> for Box<T> {
 870     fn borrow_mut(&mut self) -> &mut T {
 871         &mut **self
 872     }
 873 }
 874
 875 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
 876 impl<T: ?Sized> AsRef<T> for Box<T> {
 877     fn as_ref(&self) -> &T {
 878         &**self
 879     }
 880 }
 881
 882 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
 883 impl<T: ?Sized> AsMut<T> for Box<T> {
 884     fn as_mut(&mut self) -> &mut T {
 885         &mut **self
 886     }
 887 }
 888
 889 #[unstable(feature = "generator_trait", issue = "43122")]
 890 impl<T> Generator for Box<T>
 891     where T: Generator + ?Sized
 892 {
 893     type Yield = T::Yield;
 894     type Return = T::Return;
 895     fn resume(&mut self) -> GeneratorState<Self::Yield, Self::Return> {
 896         (**self).resume()
 897     }
 898 }