bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #38930 - insaneinside:place-left-arrow-syntax-docs, r=brson

Browse source 
Updates to src/libcore/ops.rs docs for RFC#1228 (Placement Left Arrow)

Also fixed a minor typo in docs for `core::ops::Place`.
This commit is contained in:
Guillaume Gomez 2017-01-25 17:08:14 +01:00 • committed by GitHub
commit 6ca35a6e18
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/libcore/ops.rs
View file

@ -2776,7 +2776,7 @@ impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<*const U> for *mut T {}
#[unstable(feature = "coerce_unsized", issue = "27732")] #[unstable(feature = "coerce_unsized", issue = "27732")]
impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<*const U> for *const T {} impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<*const U> for *const T {}
/// Both `in (PLACE) EXPR` and `box EXPR` desugar into expressions /// Both `PLACE <- EXPR` and `box EXPR` desugar into expressions
/// that allocate an intermediate "place" that holds uninitialized /// that allocate an intermediate "place" that holds uninitialized
/// state. The desugaring evaluates EXPR, and writes the result at /// state. The desugaring evaluates EXPR, and writes the result at
/// the address returned by the `pointer` method of this trait. /// the address returned by the `pointer` method of this trait.
@ -2791,7 +2791,7 @@ impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<*const U> for *const T {}
/// converting the agent to an instance of the owning pointer, via the /// converting the agent to an instance of the owning pointer, via the
/// appropriate `finalize` method (see the `InPlace`. /// appropriate `finalize` method (see the `InPlace`.
/// ///
/// If evaluating EXPR fails, then the destructor for the /// If evaluating EXPR fails, then it is up to the destructor for the
/// implementation of Place to clean up any intermediate state /// implementation of Place to clean up any intermediate state
/// (e.g. deallocate box storage, pop a stack, etc). /// (e.g. deallocate box storage, pop a stack, etc).
#[unstable(feature = "placement_new_protocol", issue = "27779")] #[unstable(feature = "placement_new_protocol", issue = "27779")]
@ -2802,9 +2802,9 @@ pub trait Place<Data: ?Sized> {
fn pointer(&mut self) -> *mut Data; fn pointer(&mut self) -> *mut Data;
} }
/// Interface to implementations of `in (PLACE) EXPR`. /// Interface to implementations of `PLACE <- EXPR`.
/// ///
/// `in (PLACE) EXPR` effectively desugars into: /// `PLACE <- EXPR` effectively desugars into:
/// ///
/// ```rust,ignore /// ```rust,ignore
/// let p = PLACE; /// let p = PLACE;
@ -2817,7 +2817,7 @@ pub trait Place<Data: ?Sized> {
/// } /// }
/// ``` /// ```
/// ///
/// The type of `in (PLACE) EXPR` is derived from the type of `PLACE`; /// The type of `PLACE <- EXPR` is derived from the type of `PLACE`;
/// if the type of `PLACE` is `P`, then the final type of the whole /// if the type of `PLACE` is `P`, then the final type of the whole
/// expression is `P::Place::Owner` (see the `InPlace` and `Boxed` /// expression is `P::Place::Owner` (see the `InPlace` and `Boxed`
/// traits). /// traits).
@ -2835,12 +2835,12 @@ pub trait Placer<Data: ?Sized> {
fn make_place(self) -> Self::Place; fn make_place(self) -> Self::Place;
} }
/// Specialization of `Place` trait supporting `in (PLACE) EXPR`. /// Specialization of `Place` trait supporting `PLACE <- EXPR`.
#[unstable(feature = "placement_new_protocol", issue = "27779")] #[unstable(feature = "placement_new_protocol", issue = "27779")]
pub trait InPlace<Data: ?Sized>: Place<Data> { pub trait InPlace<Data: ?Sized>: Place<Data> {
/// `Owner` is the type of the end value of `in (PLACE) EXPR` /// `Owner` is the type of the end value of `PLACE <- EXPR`
/// ///
/// Note that when `in (PLACE) EXPR` is solely used for /// Note that when `PLACE <- EXPR` is solely used for
/// side-effecting an existing data-structure, /// side-effecting an existing data-structure,
/// e.g. `Vec::emplace_back`, then `Owner` need not carry any /// e.g. `Vec::emplace_back`, then `Owner` need not carry any
/// information at all (e.g. it can be the unit type `()` in that /// information at all (e.g. it can be the unit type `()` in that