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, 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 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     mem::transmute(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         mem::transmute(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         unsafe { mem::transmute(b) }
 299     }
 300
 301     /// Consumes the `Box`, returning the wrapped pointer as `Unique<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 raw pointer back into a
 307     /// `Box` with the [`Box::from_raw`] function.
 308     ///
 309     /// Note: this is an associated function, which means that you have
 310     /// to call it as `Box::into_unique(b)` instead of `b.into_unique()`. This
 311     /// is so that there is no conflict with a method on the inner type.
 312     ///
 313     /// [`Box::from_raw`]: struct.Box.html#method.from_raw
 314     ///
 315     /// # Examples
 316     ///
 317     /// ```
 318     /// #![feature(unique)]
 319     ///
 320     /// fn main() {
 321     ///     let x = Box::new(5);
 322     ///     let ptr = Box::into_unique(x);
 323     /// }
 324     /// ```
 325     #[unstable(feature = "unique", reason = "needs an RFC to flesh out design",
 326                issue = "27730")]
 327     #[inline]
 328     pub fn into_unique(b: Box<T>) -> Unique<T> {
 329         unsafe { mem::transmute(b) }
 330     }
 331 }
 332
 333 #[stable(feature = "rust1", since = "1.0.0")]
 334 unsafe impl<#[may_dangle] T: ?Sized> Drop for Box<T> {
 335     fn drop(&mut self) {
 336         // FIXME: Do nothing, drop is currently performed by compiler.
 337     }
 338 }
 339
 340 #[stable(feature = "rust1", since = "1.0.0")]
 341 impl<T: Default> Default for Box<T> {
 342     /// Creates a `Box<T>`, with the `Default` value for T.
 343     fn default() -> Box<T> {
 344         box Default::default()
 345     }
 346 }
 347
 348 #[stable(feature = "rust1", since = "1.0.0")]
 349 impl<T> Default for Box<[T]> {
 350     fn default() -> Box<[T]> {
 351         Box::<[T; 0]>::new([])
 352     }
 353 }
 354
 355 #[stable(feature = "default_box_extra", since = "1.17.0")]
 356 impl Default for Box<str> {
 357     fn default() -> Box<str> {
 358         unsafe { from_boxed_utf8_unchecked(Default::default()) }
 359     }
 360 }
 361
 362 #[stable(feature = "rust1", since = "1.0.0")]
 363 impl<T: Clone> Clone for Box<T> {
 364     /// Returns a new box with a `clone()` of this box's contents.
 365     ///
 366     /// # Examples
 367     ///
 368     /// ```
 369     /// let x = Box::new(5);
 370     /// let y = x.clone();
 371     /// ```
 372     #[rustfmt_skip]
 373     #[inline]
 374     fn clone(&self) -> Box<T> {
 375         box { (**self).clone() }
 376     }
 377     /// Copies `source`'s contents into `self` without creating a new allocation.
 378     ///
 379     /// # Examples
 380     ///
 381     /// ```
 382     /// let x = Box::new(5);
 383     /// let mut y = Box::new(10);
 384     ///
 385     /// y.clone_from(&x);
 386     ///
 387     /// assert_eq!(*y, 5);
 388     /// ```
 389     #[inline]
 390     fn clone_from(&mut self, source: &Box<T>) {
 391         (**self).clone_from(&(**source));
 392     }
 393 }
 394
 395
 396 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 397 impl Clone for Box<str> {
 398     fn clone(&self) -> Self {
 399         let len = self.len();
 400         let buf = RawVec::with_capacity(len);
 401         unsafe {
 402             ptr::copy_nonoverlapping(self.as_ptr(), buf.ptr(), len);
 403             from_boxed_utf8_unchecked(buf.into_box())
 404         }
 405     }
 406 }
 407
 408 #[stable(feature = "rust1", since = "1.0.0")]
 409 impl<T: ?Sized + PartialEq> PartialEq for Box<T> {
 410     #[inline]
 411     fn eq(&self, other: &Box<T>) -> bool {
 412         PartialEq::eq(&**self, &**other)
 413     }
 414     #[inline]
 415     fn ne(&self, other: &Box<T>) -> bool {
 416         PartialEq::ne(&**self, &**other)
 417     }
 418 }
 419 #[stable(feature = "rust1", since = "1.0.0")]
 420 impl<T: ?Sized + PartialOrd> PartialOrd for Box<T> {
 421     #[inline]
 422     fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering> {
 423         PartialOrd::partial_cmp(&**self, &**other)
 424     }
 425     #[inline]
 426     fn lt(&self, other: &Box<T>) -> bool {
 427         PartialOrd::lt(&**self, &**other)
 428     }
 429     #[inline]
 430     fn le(&self, other: &Box<T>) -> bool {
 431         PartialOrd::le(&**self, &**other)
 432     }
 433     #[inline]
 434     fn ge(&self, other: &Box<T>) -> bool {
 435         PartialOrd::ge(&**self, &**other)
 436     }
 437     #[inline]
 438     fn gt(&self, other: &Box<T>) -> bool {
 439         PartialOrd::gt(&**self, &**other)
 440     }
 441 }
 442 #[stable(feature = "rust1", since = "1.0.0")]
 443 impl<T: ?Sized + Ord> Ord for Box<T> {
 444     #[inline]
 445     fn cmp(&self, other: &Box<T>) -> Ordering {
 446         Ord::cmp(&**self, &**other)
 447     }
 448 }
 449 #[stable(feature = "rust1", since = "1.0.0")]
 450 impl<T: ?Sized + Eq> Eq for Box<T> {}
 451
 452 #[stable(feature = "rust1", since = "1.0.0")]
 453 impl<T: ?Sized + Hash> Hash for Box<T> {
 454     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 455         (**self).hash(state);
 456     }
 457 }
 458
 459 #[stable(feature = "indirect_hasher_impl", since = "1.22.0")]
 460 impl<T: ?Sized + Hasher> Hasher for Box<T> {
 461     fn finish(&self) -> u64 {
 462         (**self).finish()
 463     }
 464     fn write(&mut self, bytes: &[u8]) {
 465         (**self).write(bytes)
 466     }
 467     fn write_u8(&mut self, i: u8) {
 468         (**self).write_u8(i)
 469     }
 470     fn write_u16(&mut self, i: u16) {
 471         (**self).write_u16(i)
 472     }
 473     fn write_u32(&mut self, i: u32) {
 474         (**self).write_u32(i)
 475     }
 476     fn write_u64(&mut self, i: u64) {
 477         (**self).write_u64(i)
 478     }
 479     fn write_u128(&mut self, i: u128) {
 480         (**self).write_u128(i)
 481     }
 482     fn write_usize(&mut self, i: usize) {
 483         (**self).write_usize(i)
 484     }
 485     fn write_i8(&mut self, i: i8) {
 486         (**self).write_i8(i)
 487     }
 488     fn write_i16(&mut self, i: i16) {
 489         (**self).write_i16(i)
 490     }
 491     fn write_i32(&mut self, i: i32) {
 492         (**self).write_i32(i)
 493     }
 494     fn write_i64(&mut self, i: i64) {
 495         (**self).write_i64(i)
 496     }
 497     fn write_i128(&mut self, i: i128) {
 498         (**self).write_i128(i)
 499     }
 500     fn write_isize(&mut self, i: isize) {
 501         (**self).write_isize(i)
 502     }
 503 }
 504
 505 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
 506 impl<T> From<T> for Box<T> {
 507     fn from(t: T) -> Self {
 508         Box::new(t)
 509     }
 510 }
 511
 512 #[stable(feature = "box_from_slice", since = "1.17.0")]
 513 impl<'a, T: Copy> From<&'a [T]> for Box<[T]> {
 514     fn from(slice: &'a [T]) -> Box<[T]> {
 515         let mut boxed = unsafe { RawVec::with_capacity(slice.len()).into_box() };
 516         boxed.copy_from_slice(slice);
 517         boxed
 518     }
 519 }
 520
 521 #[stable(feature = "box_from_slice", since = "1.17.0")]
 522 impl<'a> From<&'a str> for Box<str> {
 523     fn from(s: &'a str) -> Box<str> {
 524         unsafe { from_boxed_utf8_unchecked(Box::from(s.as_bytes())) }
 525     }
 526 }
 527
 528 #[stable(feature = "boxed_str_conv", since = "1.19.0")]
 529 impl From<Box<str>> for Box<[u8]> {
 530     fn from(s: Box<str>) -> Self {
 531         unsafe {
 532             mem::transmute(s)
 533         }
 534     }
 535 }
 536
 537 impl Box<Any> {
 538     #[inline]
 539     #[stable(feature = "rust1", since = "1.0.0")]
 540     /// Attempt to downcast the box to a concrete type.
 541     ///
 542     /// # Examples
 543     ///
 544     /// ```
 545     /// use std::any::Any;
 546     ///
 547     /// fn print_if_string(value: Box<Any>) {
 548     ///     if let Ok(string) = value.downcast::<String>() {
 549     ///         println!("String ({}): {}", string.len(), string);
 550     ///     }
 551     /// }
 552     ///
 553     /// fn main() {
 554     ///     let my_string = "Hello World".to_string();
 555     ///     print_if_string(Box::new(my_string));
 556     ///     print_if_string(Box::new(0i8));
 557     /// }
 558     /// ```
 559     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any>> {
 560         if self.is::<T>() {
 561             unsafe {
 562                 let raw: *mut Any = Box::into_raw(self);
 563                 Ok(Box::from_raw(raw as *mut T))
 564             }
 565         } else {
 566             Err(self)
 567         }
 568     }
 569 }
 570
 571 impl Box<Any + Send> {
 572     #[inline]
 573     #[stable(feature = "rust1", since = "1.0.0")]
 574     /// Attempt to downcast the box to a concrete type.
 575     ///
 576     /// # Examples
 577     ///
 578     /// ```
 579     /// use std::any::Any;
 580     ///
 581     /// fn print_if_string(value: Box<Any + Send>) {
 582     ///     if let Ok(string) = value.downcast::<String>() {
 583     ///         println!("String ({}): {}", string.len(), string);
 584     ///     }
 585     /// }
 586     ///
 587     /// fn main() {
 588     ///     let my_string = "Hello World".to_string();
 589     ///     print_if_string(Box::new(my_string));
 590     ///     print_if_string(Box::new(0i8));
 591     /// }
 592     /// ```
 593     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any + Send>> {
 594         <Box<Any>>::downcast(self).map_err(|s| unsafe {
 595             // reapply the Send marker
 596             mem::transmute::<Box<Any>, Box<Any + Send>>(s)
 597         })
 598     }
 599 }
 600
 601 #[stable(feature = "rust1", since = "1.0.0")]
 602 impl<T: fmt::Display + ?Sized> fmt::Display for Box<T> {
 603     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 604         fmt::Display::fmt(&**self, f)
 605     }
 606 }
 607
 608 #[stable(feature = "rust1", since = "1.0.0")]
 609 impl<T: fmt::Debug + ?Sized> fmt::Debug for Box<T> {
 610     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 611         fmt::Debug::fmt(&**self, f)
 612     }
 613 }
 614
 615 #[stable(feature = "rust1", since = "1.0.0")]
 616 impl<T: ?Sized> fmt::Pointer for Box<T> {
 617     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 618         // It's not possible to extract the inner Uniq directly from the Box,
 619         // instead we cast it to a *const which aliases the Unique
 620         let ptr: *const T = &**self;
 621         fmt::Pointer::fmt(&ptr, f)
 622     }
 623 }
 624
 625 #[stable(feature = "rust1", since = "1.0.0")]
 626 impl<T: ?Sized> Deref for Box<T> {
 627     type Target = T;
 628
 629     fn deref(&self) -> &T {
 630         &**self
 631     }
 632 }
 633
 634 #[stable(feature = "rust1", since = "1.0.0")]
 635 impl<T: ?Sized> DerefMut for Box<T> {
 636     fn deref_mut(&mut self) -> &mut T {
 637         &mut **self
 638     }
 639 }
 640
 641 #[stable(feature = "rust1", since = "1.0.0")]
 642 impl<I: Iterator + ?Sized> Iterator for Box<I> {
 643     type Item = I::Item;
 644     fn next(&mut self) -> Option<I::Item> {
 645         (**self).next()
 646     }
 647     fn size_hint(&self) -> (usize, Option<usize>) {
 648         (**self).size_hint()
 649     }
 650     fn nth(&mut self, n: usize) -> Option<I::Item> {
 651         (**self).nth(n)
 652     }
 653 }
 654 #[stable(feature = "rust1", since = "1.0.0")]
 655 impl<I: DoubleEndedIterator + ?Sized> DoubleEndedIterator for Box<I> {
 656     fn next_back(&mut self) -> Option<I::Item> {
 657         (**self).next_back()
 658     }
 659 }
 660 #[stable(feature = "rust1", since = "1.0.0")]
 661 impl<I: ExactSizeIterator + ?Sized> ExactSizeIterator for Box<I> {
 662     fn len(&self) -> usize {
 663         (**self).len()
 664     }
 665     fn is_empty(&self) -> bool {
 666         (**self).is_empty()
 667     }
 668 }
 669
 670 #[unstable(feature = "fused", issue = "35602")]
 671 impl<I: FusedIterator + ?Sized> FusedIterator for Box<I> {}
 672
 673
 674 /// `FnBox` is a version of the `FnOnce` intended for use with boxed
 675 /// closure objects. The idea is that where one would normally store a
 676 /// `Box<FnOnce()>` in a data structure, you should use
 677 /// `Box<FnBox()>`. The two traits behave essentially the same, except
 678 /// that a `FnBox` closure can only be called if it is boxed. (Note
 679 /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
 680 /// closures become directly usable.)
 681 ///
 682 /// # Examples
 683 ///
 684 /// Here is a snippet of code which creates a hashmap full of boxed
 685 /// once closures and then removes them one by one, calling each
 686 /// closure as it is removed. Note that the type of the closures
 687 /// stored in the map is `Box<FnBox() -> i32>` and not `Box<FnOnce()
 688 /// -> i32>`.
 689 ///
 690 /// ```
 691 /// #![feature(fnbox)]
 692 ///
 693 /// use std::boxed::FnBox;
 694 /// use std::collections::HashMap;
 695 ///
 696 /// fn make_map() -> HashMap<i32, Box<FnBox() -> i32>> {
 697 ///     let mut map: HashMap<i32, Box<FnBox() -> i32>> = HashMap::new();
 698 ///     map.insert(1, Box::new(|| 22));
 699 ///     map.insert(2, Box::new(|| 44));
 700 ///     map
 701 /// }
 702 ///
 703 /// fn main() {
 704 ///     let mut map = make_map();
 705 ///     for i in &[1, 2] {
 706 ///         let f = map.remove(&i).unwrap();
 707 ///         assert_eq!(f(), i * 22);
 708 ///     }
 709 /// }
 710 /// ```
 711 #[rustc_paren_sugar]
 712 #[unstable(feature = "fnbox",
 713            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 714 pub trait FnBox<A> {
 715     type Output;
 716
 717     fn call_box(self: Box<Self>, args: A) -> Self::Output;
 718 }
 719
 720 #[unstable(feature = "fnbox",
 721            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 722 impl<A, F> FnBox<A> for F
 723     where F: FnOnce<A>
 724 {
 725     type Output = F::Output;
 726
 727     fn call_box(self: Box<F>, args: A) -> F::Output {
 728         self.call_once(args)
 729     }
 730 }
 731
 732 #[unstable(feature = "fnbox",
 733            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 734 impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + 'a> {
 735     type Output = R;
 736
 737     extern "rust-call" fn call_once(self, args: A) -> R {
 738         self.call_box(args)
 739     }
 740 }
 741
 742 #[unstable(feature = "fnbox",
 743            reason = "will be deprecated if and when `Box<FnOnce>` becomes usable", issue = "28796")]
 744 impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + Send + 'a> {
 745     type Output = R;
 746
 747     extern "rust-call" fn call_once(self, args: A) -> R {
 748         self.call_box(args)
 749     }
 750 }
 751
 752 #[unstable(feature = "coerce_unsized", issue = "27732")]
 753 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Box<U>> for Box<T> {}
 754
 755 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 756 impl<T: Clone> Clone for Box<[T]> {
 757     fn clone(&self) -> Self {
 758         let mut new = BoxBuilder {
 759             data: RawVec::with_capacity(self.len()),
 760             len: 0,
 761         };
 762
 763         let mut target = new.data.ptr();
 764
 765         for item in self.iter() {
 766             unsafe {
 767                 ptr::write(target, item.clone());
 768                 target = target.offset(1);
 769             };
 770
 771             new.len += 1;
 772         }
 773
 774         return unsafe { new.into_box() };
 775
 776         // Helper type for responding to panics correctly.
 777         struct BoxBuilder<T> {
 778             data: RawVec<T>,
 779             len: usize,
 780         }
 781
 782         impl<T> BoxBuilder<T> {
 783             unsafe fn into_box(self) -> Box<[T]> {
 784                 let raw = ptr::read(&self.data);
 785                 mem::forget(self);
 786                 raw.into_box()
 787             }
 788         }
 789
 790         impl<T> Drop for BoxBuilder<T> {
 791             fn drop(&mut self) {
 792                 let mut data = self.data.ptr();
 793                 let max = unsafe { data.offset(self.len as isize) };
 794
 795                 while data != max {
 796                     unsafe {
 797                         ptr::read(data);
 798                         data = data.offset(1);
 799                     }
 800                 }
 801             }
 802         }
 803     }
 804 }
 805
 806 #[stable(feature = "box_borrow", since = "1.1.0")]
 807 impl<T: ?Sized> borrow::Borrow<T> for Box<T> {
 808     fn borrow(&self) -> &T {
 809         &**self
 810     }
 811 }
 812
 813 #[stable(feature = "box_borrow", since = "1.1.0")]
 814 impl<T: ?Sized> borrow::BorrowMut<T> for Box<T> {
 815     fn borrow_mut(&mut self) -> &mut T {
 816         &mut **self
 817     }
 818 }
 819
 820 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
 821 impl<T: ?Sized> AsRef<T> for Box<T> {
 822     fn as_ref(&self) -> &T {
 823         &**self
 824     }
 825 }
 826
 827 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
 828 impl<T: ?Sized> AsMut<T> for Box<T> {
 829     fn as_mut(&mut self) -> &mut T {
 830         &mut **self
 831     }
 832 }
 833
 834 #[unstable(feature = "generator_trait", issue = "43122")]
 835 impl<T> Generator for Box<T>
 836     where T: Generator + ?Sized
 837 {
 838     type Yield = T::Yield;
 839     type Return = T::Return;
 840     fn resume(&mut self) -> GeneratorState<Self::Yield, Self::Return> {
 841         (**self).resume()
 842     }
 843 }