unique.rs.html -- source
Description: Source to the Rust file `src\libcore\ptr\unique.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183

    use crate::convert::From;
    use crate::fmt;
    use crate::marker::{PhantomData, Unsize};
    use crate::mem;
    use crate::ops::{CoerceUnsized, DispatchFromDyn};

    // ignore-tidy-undocumented-unsafe

    /// A wrapper around a raw non-null `*mut T` that indicates that the possessor
    /// of this wrapper owns the referent. Useful for building abstractions like
    /// `Box<T>`, `Vec<T>`, `String`, and `HashMap<K, V>`.
    ///
    /// Unlike `*mut T`, `Unique<T>` behaves "as if" it were an instance of `T`.
    /// It implements `Send`/`Sync` if `T` is `Send`/`Sync`. It also implies
    /// the kind of strong aliasing guarantees an instance of `T` can expect:
    /// the referent of the pointer should not be modified without a unique path to
    /// its owning Unique.
    ///
    /// If you're uncertain of whether it's correct to use `Unique` for your purposes,
    /// consider using `NonNull`, which has weaker semantics.
    ///
    /// Unlike `*mut T`, the pointer must always be non-null, even if the pointer
    /// is never dereferenced. This is so that enums may use this forbidden value
    /// as a discriminant -- `Option<Unique<T>>` has the same size as `Unique<T>`.
    /// However the pointer may still dangle if it isn't dereferenced.
    ///
    /// Unlike `*mut T`, `Unique<T>` is covariant over `T`. This should always be correct
    /// for any type which upholds Unique's aliasing requirements.
    #[unstable(
        feature = "ptr_internals",
        issue = "none",
        reason = "use `NonNull` instead and consider `PhantomData<T>` \
                  (if you also use `#[may_dangle]`), `Send`, and/or `Sync`"
    )]
    #[doc(hidden)]
    #[repr(transparent)]
    #[rustc_layout_scalar_valid_range_start(1)]
    pub struct Unique<T: ?Sized> {
        pointer: *const T,
        // NOTE: this marker has no consequences for variance, but is necessary
        // for dropck to understand that we logically own a `T`.
        //
        // For details, see:
        // https://github.com/rust-lang/rfcs/blob/master/text/0769-sound-generic-drop.md#phantom-data
        _marker: PhantomData<T>,
    }

    /// `Unique` pointers are `Send` if `T` is `Send` because the data they
    /// reference is unaliased. Note that this aliasing invariant is
    /// unenforced by the type system; the abstraction using the
    /// `Unique` must enforce it.
    #[unstable(feature = "ptr_internals", issue = "none")]
    unsafe impl<T: Send + ?Sized> Send for Unique<T> {}

    /// `Unique` pointers are `Sync` if `T` is `Sync` because the data they
    /// reference is unaliased. Note that this aliasing invariant is
    /// unenforced by the type system; the abstraction using the
    /// `Unique` must enforce it.
    #[unstable(feature = "ptr_internals", issue = "none")]
    unsafe impl<T: Sync + ?Sized> Sync for Unique<T> {}

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: Sized> Unique<T> {
        /// Creates a new `Unique` that is dangling, but well-aligned.
        ///
        /// This is useful for initializing types which lazily allocate, like
        /// `Vec::new` does.
        ///
        /// Note that the pointer value may potentially represent a valid pointer to
        /// a `T`, which means this must not be used as a "not yet initialized"
        /// sentinel value. Types that lazily allocate must track initialization by
        /// some other means.
        #[inline]
        pub const fn dangling() -> Self {
            // SAFETY: mem::align_of() returns a valid, non-null pointer. The
            // conditions to call new_unchecked() are thus respected.
            unsafe { Unique::new_unchecked(mem::align_of::<T>() as *mut T) }
        }
    }

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> Unique<T> {
        /// Creates a new `Unique`.
        ///
        /// # Safety
        ///
        /// `ptr` must be non-null.
        #[inline]
        pub const unsafe fn new_unchecked(ptr: *mut T) -> Self {
            // SAFETY: the caller must guarantee that `ptr` is non-null.
            unsafe { Unique { pointer: ptr as _, _marker: PhantomData } }
        }

        /// Creates a new `Unique` if `ptr` is non-null.
        #[inline]
        pub fn new(ptr: *mut T) -> Option<Self> {
            if !ptr.is_null() {
                // SAFETY: The pointer has already been checked and is not null.
                Some(unsafe { Unique { pointer: ptr as _, _marker: PhantomData } })
            } else {
                None
            }
        }

        /// Acquires the underlying `*mut` pointer.
        #[inline]
        pub const fn as_ptr(self) -> *mut T {
            self.pointer as *mut T
        }

        /// Dereferences the content.
        ///
        /// The resulting lifetime is bound to self so this behaves "as if"
        /// it were actually an instance of T that is getting borrowed. If a longer
        /// (unbound) lifetime is needed, use `&*my_ptr.as_ptr()`.
        #[inline]
        pub unsafe fn as_ref(&self) -> &T {
            // SAFETY: the caller must guarantee that `self` meets all the
            // requirements for a reference.
            unsafe { &*self.as_ptr() }
        }

        /// Mutably dereferences the content.
        ///
        /// The resulting lifetime is bound to self so this behaves "as if"
        /// it were actually an instance of T that is getting borrowed. If a longer
        /// (unbound) lifetime is needed, use `&mut *my_ptr.as_ptr()`.
        #[inline]
        pub unsafe fn as_mut(&mut self) -> &mut T {
            // SAFETY: the caller must guarantee that `self` meets all the
            // requirements for a mutable reference.
            unsafe { &mut *self.as_ptr() }
        }

        /// Casts to a pointer of another type.
        #[inline]
        pub const fn cast<U>(self) -> Unique<U> {
            // SAFETY: Unique::new_unchecked() creates a new unique and needs
            // the given pointer to not be null.
            // Since we are passing self as a pointer, it cannot be null.
            unsafe { Unique::new_unchecked(self.as_ptr() as *mut U) }
        }
    }

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> Clone for Unique<T> {
        #[inline]
        fn clone(&self) -> Self {
            *self
        }
    }

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> Copy for Unique<T> {}

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized, U: ?Sized> CoerceUnsized<Unique<U>> for Unique<T> where T: Unsize<U> {}

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized, U: ?Sized> DispatchFromDyn<Unique<U>> for Unique<T> where T: Unsize<U> {}

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> fmt::Debug for Unique<T> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt::Pointer::fmt(&self.as_ptr(), f)
        }
    }

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> fmt::Pointer for Unique<T> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt::Pointer::fmt(&self.as_ptr(), f)
        }
    }

    #[unstable(feature = "ptr_internals", issue = "none")]
    impl<T: ?Sized> From<&mut T> for Unique<T> {
        #[inline]
        fn from(reference: &mut T) -> Self {
            // SAFETY: A mutable reference cannot be null
            unsafe { Unique { pointer: reference as *mut T, _marker: PhantomData } }
        }
    }