       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
     184
     185
     186
     187
     188
     189
     190
     191
     192
     193
     194
     195
     196
     197
     198
     199
     200
     201
     202
     203
     204
     205
     206
     207
     208
     209
     210
     211
     212
     213
     214
     215
     216
     217
     218
     219
     220
     221
     222
     223
     224
     225
     226
     227
     228
     229
     230
     231
     232
     233
     234
     235
     236
     237
     238
     239
     240
     241
     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
     252
     253
     254
     255
     256
     257
     258
     259
     260
     261
     262
     263
     264
     265
     266
     267
     268
     269
     270
     271
     272
     273
     274
     275
     276
     277
     278
     279
     280
     281
     282
     283
     284
     285
     286
     287
     288
     289
     290
     291
     292
     293
     294
     295
     296
     297
     298
     299
     300
     301
     302
     303
     304
     305
     306
     307
     308
     309
     310
     311
     312
     313
     314
     315
     316
     317
     318
     319
     320
     321
     322
     323
     324
     325
     326
     327
     328
     329
     330
     331
     332
     333
     334
     335
     336
     337
     338
     339
     340
     341
     342
     343
     344
     345
     346
     347
     348
     349
     350
     351
     352
     353
     354
     355
     356
     357
     358
     359
     360
     361
     362
     363
     364
     365
     366
     367
     368
     369
     370
     371
     372
     373
     374
     375
     376
     377
     378
     379
     380
     381
     382
     383
     384
     385
     386
     387
     388
     389
     390
     391
     392
     393
     394
     395
     396
     397
     398
     399
     400
     401
     402
     403
     404
     405
     406
     407
     408
     409
     410
     411
     412
     413
     414
     415
     416
     417
     418
     419
     420
     421
     422
     423
     424
     425
     426
     427
     428
     429
     430
     431
     432
     433
     434
     435
     436
     437
     438
     439
     440
     441
     442
     443
     444
     445
     446
     447
     448
     449
     450
     451
     452
     453
     454
     455
     456
     457
     458
     459
     460
     461
     462
     463
     464
     465
     466
     467
     468
     469
     470
     471
     472
     473
     474
     475
     476
     477
     478
     479
     480
     481
     482
     483
     484
     485
     486
     487
     488
     489
     490
     491
     492
     493
     494
     495
     496
     497
     498
     499
     500
     501
     502
     503
     504
     505
     506
     507
     508
     509
     510
     511
     512
     513
     514
     515
     516
     517
     518
     519
     520
     521
     522
     523
     524
     525
     526
     527
     528
     529
     530
     531
     532
     533
     534
     535
     536
     537
     538
     539
     540
     541
     542
     543
     544
     545
     546
     547
     548
     549
     550
     551
     552
     553
     554
     555
     556
     557
     558
     559
     560
     561
     562
     563
     564
     565
     566
     567
     568
     569
     570
     571
     572
     573
     574
     575
     576
     577
     578
     579
     580
     581
     582
     583
     584
     585
     586
     587
     588
     589
     590
     591
     592
     593
     594
     595
     596
     597
     598
     599
     600
     601
     602
     603
     604
     605
     606
     607
     608
     609
     610
     611
     612
     613
     614
     615
     616
     617
     618
     619
     620
     621
     622
     623
     624
     625
     626
     627
     628
     629
     630
     631
     632
     633
     634
     635
     636
     637
     638
     639
     640
     641
     642
     643
     644
     645
     646
     647
     648
     649
     650
     651
     652
     653
     654
     655
     656
     657
     658
     659
     660
     661
     662
     663
     664
     665
     666
     667
     668
     669
     670
     671
     672
     673
     674
     675
     676
     677
     678
     679
     680
     681
     682
     683
     684
     685
     686
     687
     688
     689
     690
     691
     692
     693
     694
     695
     696
     697
     698
     699
     700
     701
     702
     703
     704
     705
     706
     707
     708
     709
     710
     711
     712
     713
     714
     715
     716
     717
     718
     719
     720
     721
     722
     723
     724
     725
     726
     727
     728
     729
     730
     731
     732
     733
     734
     735
     736
     737
     738
     739
     740
     741
     742
     743
     744
     745
     746
     747
     748
     749
     750
     751
     752
     753
     754
     755
     756
     757
     758
     759
     760
     761
     762
     763
     764
     765
     766
     767
     768
     769
     770
     771
     772
     773
     774
     775
     776
     777
     778
     779
     780
     781
     782
     783
     784
     785
     786
     787
     788
     789
     790
     791
     792
     793
     794
     795
     796
     797
     798
     799
     800
     801
     802
     803
     804
     805
     806
     807
     808
     809
     810
     811
     812
     813
     814
     815
     816
     817
     818
     819
     820
     821
     822
     823
     824
     825
     826
     827
     828
     829
     830
     831
     832
     833
     834
     835
     836
     837
     838
     839
     840
     841
     842
     843
     844
     845
     846
     847
     848
     849
     850
     851
     852
     853
     854
     855
     856
     857
     858
     859
     860
     861
     862
     863
     864
     865
     866
     867
     868
     869
     870
     871
     872
     873
     874
     875
     876
     877
     878
     879
     880
     881
     882
     883
     884
     885
     886
     887
     888
     889
     890
     891
     892
     893
     894
     895
     896
     897
     898
     899
     900
     901
     902
     903
     904
     905
     906
     907
     908
     909
     910
     911
     912
     913
     914
     915
     916
     917
     918
     919
     920
     921
     922
     923
     924
     925
     926
     927
     928
     929
     930
     931
     932
     933
     934
     935
     936
     937
     938
     939
     940
     941
     942
     943
     944
     945
     946
     947
     948
     949
     950
     951
     952
     953
     954
     955
     956
     957
     958
     959
     960
     961
     962
     963
     964
     965
     966
     967
     968
     969
     970
     971
     972
     973
     974
     975
     976
     977
     978
     979
     980
     981
     982
     983
     984
     985
     986
     987
     988
     989
     990
     991
     992
     993
     994
     995
     996
     997
     998
     999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    1076
    1077
    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093
    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116

    // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    // FIXME: talk about offset, copy_memory, copy_nonoverlapping_memory

    //! Raw, unsafe pointers, `*const T`, and `*mut T`.
    //!
    //! *[See also the pointer primitive types](../../std/primitive.pointer.html).*

    #![stable(feature = "rust1", since = "1.0.0")]

    use intrinsics;
    use ops::{CoerceUnsized, Deref};
    use fmt;
    use hash;
    use marker::{PhantomData, Unsize};
    use mem;
    use nonzero::NonZero;

    use cmp::Ordering::{self, Less, Equal, Greater};

    // FIXME #19649: intrinsic docs don't render, so these have no docs :(

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use intrinsics::copy_nonoverlapping;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use intrinsics::copy;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use intrinsics::write_bytes;

    #[cfg(stage0)]
    #[stable(feature = "drop_in_place", since = "1.8.0")]
    pub use intrinsics::drop_in_place;

    #[cfg(not(stage0))]
    /// Executes the destructor (if any) of the pointed-to value.
    ///
    /// This has two use cases:
    ///
    /// * It is *required* to use `drop_in_place` to drop unsized types like
    ///   trait objects, because they can't be read out onto the stack and
    ///   dropped normally.
    ///
    /// * It is friendlier to the optimizer to do this over `ptr::read` when
    ///   dropping manually allocated memory (e.g. when writing Box/Rc/Vec),
    ///   as the compiler doesn't need to prove that it's sound to elide the
    ///   copy.
    ///
    /// # Undefined Behavior
    ///
    /// This has all the same safety problems as `ptr::read` with respect to
    /// invalid pointers, types, and double drops.
    #[stable(feature = "drop_in_place", since = "1.8.0")]
    #[lang="drop_in_place"]
    #[inline]
    #[allow(unconditional_recursion)]
    pub unsafe fn drop_in_place<T: ?Sized>(to_drop: *mut T) {
        // Code here does not matter - this is replaced by the
        // real drop glue by the compiler.
        drop_in_place(to_drop);
    }

    /// Creates a null raw pointer.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::ptr;
    ///
    /// let p: *const i32 = ptr::null();
    /// assert!(p.is_null());
    /// ```
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub const fn null<T>() -> *const T { 0 as *const T }

    /// Creates a null mutable raw pointer.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::ptr;
    ///
    /// let p: *mut i32 = ptr::null_mut();
    /// assert!(p.is_null());
    /// ```
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub const fn null_mut<T>() -> *mut T { 0 as *mut T }

    /// Swaps the values at two mutable locations of the same type, without
    /// deinitializing either. They may overlap, unlike `mem::swap` which is
    /// otherwise equivalent.
    ///
    /// # Safety
    ///
    /// This function copies the memory through the raw pointers passed to it
    /// as arguments.
    ///
    /// Ensure that these pointers are valid before calling `swap`.
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub unsafe fn swap<T>(x: *mut T, y: *mut T) {
        // Give ourselves some scratch space to work with
        let mut tmp: T = mem::uninitialized();

        // Perform the swap
        copy_nonoverlapping(x, &mut tmp, 1);
        copy(y, x, 1); // `x` and `y` may overlap
        copy_nonoverlapping(&tmp, y, 1);

        // y and t now point to the same thing, but we need to completely forget `tmp`
        // because it's no longer relevant.
        mem::forget(tmp);
    }

    /// Replaces the value at `dest` with `src`, returning the old
    /// value, without dropping either.
    ///
    /// # Safety
    ///
    /// This is only unsafe because it accepts a raw pointer.
    /// Otherwise, this operation is identical to `mem::replace`.
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub unsafe fn replace<T>(dest: *mut T, mut src: T) -> T {
        mem::swap(&mut *dest, &mut src); // cannot overlap
        src
    }

    /// Reads the value from `src` without moving it. This leaves the
    /// memory in `src` unchanged.
    ///
    /// # Safety
    ///
    /// Beyond accepting a raw pointer, this is unsafe because it semantically
    /// moves the value out of `src` without preventing further usage of `src`.
    /// If `T` is not `Copy`, then care must be taken to ensure that the value at
    /// `src` is not used before the data is overwritten again (e.g. with `write`,
    /// `zero_memory`, or `copy_memory`). Note that `*src = foo` counts as a use
    /// because it will attempt to drop the value previously at `*src`.
    ///
    /// The pointer must be aligned; use `read_unaligned` if that is not the case.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let x = 12;
    /// let y = &x as *const i32;
    ///
    /// unsafe {
    ///     assert_eq!(std::ptr::read(y), 12);
    /// }
    /// ```
    #[inline(always)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub unsafe fn read<T>(src: *const T) -> T {
        let mut tmp: T = mem::uninitialized();
        copy_nonoverlapping(src, &mut tmp, 1);
        tmp
    }

    /// Reads the value from `src` without moving it. This leaves the
    /// memory in `src` unchanged.
    ///
    /// Unlike `read`, the pointer may be unaligned.
    ///
    /// # Safety
    ///
    /// Beyond accepting a raw pointer, this is unsafe because it semantically
    /// moves the value out of `src` without preventing further usage of `src`.
    /// If `T` is not `Copy`, then care must be taken to ensure that the value at
    /// `src` is not used before the data is overwritten again (e.g. with `write`,
    /// `zero_memory`, or `copy_memory`). Note that `*src = foo` counts as a use
    /// because it will attempt to drop the value previously at `*src`.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let x = 12;
    /// let y = &x as *const i32;
    ///
    /// unsafe {
    ///     assert_eq!(std::ptr::read_unaligned(y), 12);
    /// }
    /// ```
    #[inline(always)]
    #[stable(feature = "ptr_unaligned", since = "1.17.0")]
    pub unsafe fn read_unaligned<T>(src: *const T) -> T {
        let mut tmp: T = mem::uninitialized();
        copy_nonoverlapping(src as *const u8,
                            &mut tmp as *mut T as *mut u8,
                            mem::size_of::<T>());
        tmp
    }

    /// Overwrites a memory location with the given value without reading or
    /// dropping the old value.
    ///
    /// # Safety
    ///
    /// This operation is marked unsafe because it accepts a raw pointer.
    ///
    /// It does not drop the contents of `dst`. This is safe, but it could leak
    /// allocations or resources, so care must be taken not to overwrite an object
    /// that should be dropped.
    ///
    /// Additionally, it does not drop `src`. Semantically, `src` is moved into the
    /// location pointed to by `dst`.
    ///
    /// This is appropriate for initializing uninitialized memory, or overwriting
    /// memory that has previously been `read` from.
    ///
    /// The pointer must be aligned; use `write_unaligned` if that is not the case.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let mut x = 0;
    /// let y = &mut x as *mut i32;
    /// let z = 12;
    ///
    /// unsafe {
    ///     std::ptr::write(y, z);
    ///     assert_eq!(std::ptr::read(y), 12);
    /// }
    /// ```
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub unsafe fn write<T>(dst: *mut T, src: T) {
        intrinsics::move_val_init(&mut *dst, src)
    }

    /// Overwrites a memory location with the given value without reading or
    /// dropping the old value.
    ///
    /// Unlike `write`, the pointer may be unaligned.
    ///
    /// # Safety
    ///
    /// This operation is marked unsafe because it accepts a raw pointer.
    ///
    /// It does not drop the contents of `dst`. This is safe, but it could leak
    /// allocations or resources, so care must be taken not to overwrite an object
    /// that should be dropped.
    ///
    /// Additionally, it does not drop `src`. Semantically, `src` is moved into the
    /// location pointed to by `dst`.
    ///
    /// This is appropriate for initializing uninitialized memory, or overwriting
    /// memory that has previously been `read` from.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let mut x = 0;
    /// let y = &mut x as *mut i32;
    /// let z = 12;
    ///
    /// unsafe {
    ///     std::ptr::write_unaligned(y, z);
    ///     assert_eq!(std::ptr::read_unaligned(y), 12);
    /// }
    /// ```
    #[inline]
    #[stable(feature = "ptr_unaligned", since = "1.17.0")]
    pub unsafe fn write_unaligned<T>(dst: *mut T, src: T) {
        copy_nonoverlapping(&src as *const T as *const u8,
                            dst as *mut u8,
                            mem::size_of::<T>());
        mem::forget(src);
    }

    /// Performs a volatile read of the value from `src` without moving it. This
    /// leaves the memory in `src` unchanged.
    ///
    /// Volatile operations are intended to act on I/O memory, and are guaranteed
    /// to not be elided or reordered by the compiler across other volatile
    /// operations.
    ///
    /// # Notes
    ///
    /// Rust does not currently have a rigorously and formally defined memory model,
    /// so the precise semantics of what "volatile" means here is subject to change
    /// over time. That being said, the semantics will almost always end up pretty
    /// similar to [C11's definition of volatile][c11].
    ///
    /// [c11]: http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1570.pdf
    ///
    /// # Safety
    ///
    /// Beyond accepting a raw pointer, this is unsafe because it semantically
    /// moves the value out of `src` without preventing further usage of `src`.
    /// If `T` is not `Copy`, then care must be taken to ensure that the value at
    /// `src` is not used before the data is overwritten again (e.g. with `write`,
    /// `zero_memory`, or `copy_memory`). Note that `*src = foo` counts as a use
    /// because it will attempt to drop the value previously at `*src`.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let x = 12;
    /// let y = &x as *const i32;
    ///
    /// unsafe {
    ///     assert_eq!(std::ptr::read_volatile(y), 12);
    /// }
    /// ```
    #[inline]
    #[stable(feature = "volatile", since = "1.9.0")]
    pub unsafe fn read_volatile<T>(src: *const T) -> T {
        intrinsics::volatile_load(src)
    }

    /// Performs a volatile write of a memory location with the given value without
    /// reading or dropping the old value.
    ///
    /// Volatile operations are intended to act on I/O memory, and are guaranteed
    /// to not be elided or reordered by the compiler across other volatile
    /// operations.
    ///
    /// # Notes
    ///
    /// Rust does not currently have a rigorously and formally defined memory model,
    /// so the precise semantics of what "volatile" means here is subject to change
    /// over time. That being said, the semantics will almost always end up pretty
    /// similar to [C11's definition of volatile][c11].
    ///
    /// [c11]: http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1570.pdf
    ///
    /// # Safety
    ///
    /// This operation is marked unsafe because it accepts a raw pointer.
    ///
    /// It does not drop the contents of `dst`. This is safe, but it could leak
    /// allocations or resources, so care must be taken not to overwrite an object
    /// that should be dropped.
    ///
    /// This is appropriate for initializing uninitialized memory, or overwriting
    /// memory that has previously been `read` from.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let mut x = 0;
    /// let y = &mut x as *mut i32;
    /// let z = 12;
    ///
    /// unsafe {
    ///     std::ptr::write_volatile(y, z);
    ///     assert_eq!(std::ptr::read_volatile(y), 12);
    /// }
    /// ```
    #[inline]
    #[stable(feature = "volatile", since = "1.9.0")]
    pub unsafe fn write_volatile<T>(dst: *mut T, src: T) {
        intrinsics::volatile_store(dst, src);
    }

    #[lang = "const_ptr"]
    impl<T: ?Sized> *const T {
        /// Returns `true` if the pointer is null.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// let s: &str = "Follow the rabbit";
        /// let ptr: *const u8 = s.as_ptr();
        /// assert!(!ptr.is_null());
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        #[inline]
        pub fn is_null(self) -> bool where T: Sized {
            self == null()
        }

        /// Returns `None` if the pointer is null, or else returns a reference to
        /// the value wrapped in `Some`.
        ///
        /// # Safety
        ///
        /// While this method and its mutable counterpart are useful for
        /// null-safety, it is important to note that this is still an unsafe
        /// operation because the returned value could be pointing to invalid
        /// memory.
        ///
        /// Additionally, the lifetime `'a` returned is arbitrarily chosen and does
        /// not necessarily reflect the actual lifetime of the data.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```ignore
        /// let val: *const u8 = &10u8 as *const u8;
        ///
        /// unsafe {
        ///     if let Some(val_back) = val.as_ref() {
        ///         println!("We got back the value: {}!", val_back);
        ///     }
        /// }
        /// ```
        #[stable(feature = "ptr_as_ref", since = "1.9.0")]
        #[inline]
        pub unsafe fn as_ref<'a>(self) -> Option<&'a T> where T: Sized {
            if self.is_null() {
                None
            } else {
                Some(&*self)
            }
        }

        /// Calculates the offset from a pointer. `count` is in units of T; e.g. a
        /// `count` of 3 represents a pointer offset of `3 * size_of::<T>()` bytes.
        ///
        /// # Safety
        ///
        /// Both the starting and resulting pointer must be either in bounds or one
        /// byte past the end of an allocated object. If either pointer is out of
        /// bounds or arithmetic overflow occurs then
        /// any further use of the returned value will result in undefined behavior.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// let s: &str = "123";
        /// let ptr: *const u8 = s.as_ptr();
        ///
        /// unsafe {
        ///     println!("{}", *ptr.offset(1) as char);
        ///     println!("{}", *ptr.offset(2) as char);
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        #[inline]
        pub unsafe fn offset(self, count: isize) -> *const T where T: Sized {
            intrinsics::offset(self, count)
        }

        /// Calculates the offset from a pointer using wrapping arithmetic.
        /// `count` is in units of T; e.g. a `count` of 3 represents a pointer
        /// offset of `3 * size_of::<T>()` bytes.
        ///
        /// # Safety
        ///
        /// The resulting pointer does not need to be in bounds, but it is
        /// potentially hazardous to dereference (which requires `unsafe`).
        ///
        /// Always use `.offset(count)` instead when possible, because `offset`
        /// allows the compiler to optimize better.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// // Iterate using a raw pointer in increments of two elements
        /// let data = [1u8, 2, 3, 4, 5];
        /// let mut ptr: *const u8 = data.as_ptr();
        /// let step = 2;
        /// let end_rounded_up = ptr.wrapping_offset(6);
        ///
        /// // This loop prints "1, 3, 5, "
        /// while ptr != end_rounded_up {
        ///     unsafe {
        ///         print!("{}, ", *ptr);
        ///     }
        ///     ptr = ptr.wrapping_offset(step);
        /// }
        /// ```
        #[stable(feature = "ptr_wrapping_offset", since = "1.16.0")]
        #[inline]
        pub fn wrapping_offset(self, count: isize) -> *const T where T: Sized {
            unsafe {
                intrinsics::arith_offset(self, count)
            }
        }

        /// Calculates the distance between two pointers. The returned value is in
        /// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
        ///
        /// If the address different between the two pointers ia not a multiple of
        /// `mem::size_of::<T>()` then the result of the division is rounded towards
        /// zero.
        ///
        /// This function returns `None` if `T` is a zero-sized typed.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(offset_to)]
        ///
        /// fn main() {
        ///     let a = [0; 5];
        ///     let ptr1: *const i32 = &a[1];
        ///     let ptr2: *const i32 = &a[3];
        ///     assert_eq!(ptr1.offset_to(ptr2), Some(2));
        ///     assert_eq!(ptr2.offset_to(ptr1), Some(-2));
        ///     assert_eq!(unsafe { ptr1.offset(2) }, ptr2);
        ///     assert_eq!(unsafe { ptr2.offset(-2) }, ptr1);
        /// }
        /// ```
        #[unstable(feature = "offset_to", issue = "41079")]
        #[inline]
        pub fn offset_to(self, other: *const T) -> Option<isize> where T: Sized {
            let size = mem::size_of::<T>();
            if size == 0 {
                None
            } else {
                let diff = (other as isize).wrapping_sub(self as isize);
                Some(diff / size as isize)
            }
        }
    }

    #[lang = "mut_ptr"]
    impl<T: ?Sized> *mut T {
        /// Returns `true` if the pointer is null.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// let mut s = [1, 2, 3];
        /// let ptr: *mut u32 = s.as_mut_ptr();
        /// assert!(!ptr.is_null());
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        #[inline]
        pub fn is_null(self) -> bool where T: Sized {
            self == null_mut()
        }

        /// Returns `None` if the pointer is null, or else returns a reference to
        /// the value wrapped in `Some`.
        ///
        /// # Safety
        ///
        /// While this method and its mutable counterpart are useful for
        /// null-safety, it is important to note that this is still an unsafe
        /// operation because the returned value could be pointing to invalid
        /// memory.
        ///
        /// Additionally, the lifetime `'a` returned is arbitrarily chosen and does
        /// not necessarily reflect the actual lifetime of the data.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```ignore
        /// let val: *mut u8 = &mut 10u8 as *mut u8;
        ///
        /// unsafe {
        ///     if let Some(val_back) = val.as_ref() {
        ///         println!("We got back the value: {}!", val_back);
        ///     }
        /// }
        /// ```
        #[stable(feature = "ptr_as_ref", since = "1.9.0")]
        #[inline]
        pub unsafe fn as_ref<'a>(self) -> Option<&'a T> where T: Sized {
            if self.is_null() {
                None
            } else {
                Some(&*self)
            }
        }

        /// Calculates the offset from a pointer. `count` is in units of T; e.g. a
        /// `count` of 3 represents a pointer offset of `3 * size_of::<T>()` bytes.
        ///
        /// # Safety
        ///
        /// The offset must be in-bounds of the object, or one-byte-past-the-end.
        /// Otherwise `offset` invokes Undefined Behavior, regardless of whether
        /// the pointer is used.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// let mut s = [1, 2, 3];
        /// let ptr: *mut u32 = s.as_mut_ptr();
        ///
        /// unsafe {
        ///     println!("{}", *ptr.offset(1));
        ///     println!("{}", *ptr.offset(2));
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        #[inline]
        pub unsafe fn offset(self, count: isize) -> *mut T where T: Sized {
            intrinsics::offset(self, count) as *mut T
        }

        /// Calculates the offset from a pointer using wrapping arithmetic.
        /// `count` is in units of T; e.g. a `count` of 3 represents a pointer
        /// offset of `3 * size_of::<T>()` bytes.
        ///
        /// # Safety
        ///
        /// The resulting pointer does not need to be in bounds, but it is
        /// potentially hazardous to dereference (which requires `unsafe`).
        ///
        /// Always use `.offset(count)` instead when possible, because `offset`
        /// allows the compiler to optimize better.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// // Iterate using a raw pointer in increments of two elements
        /// let mut data = [1u8, 2, 3, 4, 5];
        /// let mut ptr: *mut u8 = data.as_mut_ptr();
        /// let step = 2;
        /// let end_rounded_up = ptr.wrapping_offset(6);
        ///
        /// while ptr != end_rounded_up {
        ///     unsafe {
        ///         *ptr = 0;
        ///     }
        ///     ptr = ptr.wrapping_offset(step);
        /// }
        /// assert_eq!(&data, &[0, 2, 0, 4, 0]);
        /// ```
        #[stable(feature = "ptr_wrapping_offset", since = "1.16.0")]
        #[inline]
        pub fn wrapping_offset(self, count: isize) -> *mut T where T: Sized {
            unsafe {
                intrinsics::arith_offset(self, count) as *mut T
            }
        }

        /// Returns `None` if the pointer is null, or else returns a mutable
        /// reference to the value wrapped in `Some`.
        ///
        /// # Safety
        ///
        /// As with `as_ref`, this is unsafe because it cannot verify the validity
        /// of the returned pointer, nor can it ensure that the lifetime `'a`
        /// returned is indeed a valid lifetime for the contained data.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// let mut s = [1, 2, 3];
        /// let ptr: *mut u32 = s.as_mut_ptr();
        /// let first_value = unsafe { ptr.as_mut().unwrap() };
        /// *first_value = 4;
        /// println!("{:?}", s); // It'll print: "[4, 2, 3]".
        /// ```
        #[stable(feature = "ptr_as_ref", since = "1.9.0")]
        #[inline]
        pub unsafe fn as_mut<'a>(self) -> Option<&'a mut T> where T: Sized {
            if self.is_null() {
                None
            } else {
                Some(&mut *self)
            }
        }

        /// Calculates the distance between two pointers. The returned value is in
        /// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
        ///
        /// If the address different between the two pointers ia not a multiple of
        /// `mem::size_of::<T>()` then the result of the division is rounded towards
        /// zero.
        ///
        /// This function returns `None` if `T` is a zero-sized typed.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(offset_to)]
        ///
        /// fn main() {
        ///     let mut a = [0; 5];
        ///     let ptr1: *mut i32 = &mut a[1];
        ///     let ptr2: *mut i32 = &mut a[3];
        ///     assert_eq!(ptr1.offset_to(ptr2), Some(2));
        ///     assert_eq!(ptr2.offset_to(ptr1), Some(-2));
        ///     assert_eq!(unsafe { ptr1.offset(2) }, ptr2);
        ///     assert_eq!(unsafe { ptr2.offset(-2) }, ptr1);
        /// }
        /// ```
        #[unstable(feature = "offset_to", issue = "41079")]
        #[inline]
        pub fn offset_to(self, other: *const T) -> Option<isize> where T: Sized {
            let size = mem::size_of::<T>();
            if size == 0 {
                None
            } else {
                let diff = (other as isize).wrapping_sub(self as isize);
                Some(diff / size as isize)
            }
        }
    }

    // Equality for pointers
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> PartialEq for *const T {
        #[inline]
        fn eq(&self, other: &*const T) -> bool { *self == *other }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Eq for *const T {}

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> PartialEq for *mut T {
        #[inline]
        fn eq(&self, other: &*mut T) -> bool { *self == *other }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Eq for *mut T {}

    /// Compare raw pointers for equality.
    ///
    /// This is the same as using the `==` operator, but less generic:
    /// the arguments have to be `*const T` raw pointers,
    /// not anything that implements `PartialEq`.
    ///
    /// This can be used to compare `&T` references (which coerce to `*const T` implicitly)
    /// by their address rather than comparing the values they point to
    /// (which is what the `PartialEq for &T` implementation does).
    ///
    /// # Examples
    ///
    /// ```
    /// use std::ptr;
    ///
    /// let five = 5;
    /// let other_five = 5;
    /// let five_ref = &five;
    /// let same_five_ref = &five;
    /// let other_five_ref = &other_five;
    ///
    /// assert!(five_ref == same_five_ref);
    /// assert!(five_ref == other_five_ref);
    ///
    /// assert!(ptr::eq(five_ref, same_five_ref));
    /// assert!(!ptr::eq(five_ref, other_five_ref));
    /// ```
    #[stable(feature = "ptr_eq", since = "1.17.0")]
    #[inline]
    pub fn eq<T: ?Sized>(a: *const T, b: *const T) -> bool {
        a == b
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Clone for *const T {
        #[inline]
        fn clone(&self) -> *const T {
            *self
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Clone for *mut T {
        #[inline]
        fn clone(&self) -> *mut T {
            *self
        }
    }

    // Impls for function pointers
    macro_rules! fnptr_impls_safety_abi {
        ($FnTy: ty, $($Arg: ident),*) => {
            #[stable(feature = "rust1", since = "1.0.0")]
            impl<Ret, $($Arg),*> Clone for $FnTy {
                #[inline]
                fn clone(&self) -> Self {
                    *self
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> PartialEq for $FnTy {
                #[inline]
                fn eq(&self, other: &Self) -> bool {
                    *self as usize == *other as usize
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> Eq for $FnTy {}

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> PartialOrd for $FnTy {
                #[inline]
                fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
                    (*self as usize).partial_cmp(&(*other as usize))
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> Ord for $FnTy {
                #[inline]
                fn cmp(&self, other: &Self) -> Ordering {
                    (*self as usize).cmp(&(*other as usize))
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> hash::Hash for $FnTy {
                fn hash<HH: hash::Hasher>(&self, state: &mut HH) {
                    state.write_usize(*self as usize)
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> fmt::Pointer for $FnTy {
                fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                    fmt::Pointer::fmt(&(*self as *const ()), f)
                }
            }

            #[stable(feature = "fnptr_impls", since = "1.4.0")]
            impl<Ret, $($Arg),*> fmt::Debug for $FnTy {
                fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                    fmt::Pointer::fmt(&(*self as *const ()), f)
                }
            }
        }
    }

    macro_rules! fnptr_impls_args {
        ($($Arg: ident),+) => {
            fnptr_impls_safety_abi! { extern "Rust" fn($($Arg),*) -> Ret, $($Arg),* }
            fnptr_impls_safety_abi! { extern "C" fn($($Arg),*) -> Ret, $($Arg),* }
            fnptr_impls_safety_abi! { extern "C" fn($($Arg),* , ...) -> Ret, $($Arg),* }
            fnptr_impls_safety_abi! { unsafe extern "Rust" fn($($Arg),*) -> Ret, $($Arg),* }
            fnptr_impls_safety_abi! { unsafe extern "C" fn($($Arg),*) -> Ret, $($Arg),* }
            fnptr_impls_safety_abi! { unsafe extern "C" fn($($Arg),* , ...) -> Ret, $($Arg),* }
        };
        () => {
            // No variadic functions with 0 parameters
            fnptr_impls_safety_abi! { extern "Rust" fn() -> Ret, }
            fnptr_impls_safety_abi! { extern "C" fn() -> Ret, }
            fnptr_impls_safety_abi! { unsafe extern "Rust" fn() -> Ret, }
            fnptr_impls_safety_abi! { unsafe extern "C" fn() -> Ret, }
        };
    }

    fnptr_impls_args! { }
    fnptr_impls_args! { A }
    fnptr_impls_args! { A, B }
    fnptr_impls_args! { A, B, C }
    fnptr_impls_args! { A, B, C, D }
    fnptr_impls_args! { A, B, C, D, E }
    fnptr_impls_args! { A, B, C, D, E, F }
    fnptr_impls_args! { A, B, C, D, E, F, G }
    fnptr_impls_args! { A, B, C, D, E, F, G, H }
    fnptr_impls_args! { A, B, C, D, E, F, G, H, I }
    fnptr_impls_args! { A, B, C, D, E, F, G, H, I, J }
    fnptr_impls_args! { A, B, C, D, E, F, G, H, I, J, K }
    fnptr_impls_args! { A, B, C, D, E, F, G, H, I, J, K, L }

    // Comparison for pointers
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Ord for *const T {
        #[inline]
        fn cmp(&self, other: &*const T) -> Ordering {
            if self < other {
                Less
            } else if self == other {
                Equal
            } else {
                Greater
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> PartialOrd for *const T {
        #[inline]
        fn partial_cmp(&self, other: &*const T) -> Option<Ordering> {
            Some(self.cmp(other))
        }

        #[inline]
        fn lt(&self, other: &*const T) -> bool { *self < *other }

        #[inline]
        fn le(&self, other: &*const T) -> bool { *self <= *other }

        #[inline]
        fn gt(&self, other: &*const T) -> bool { *self > *other }

        #[inline]
        fn ge(&self, other: &*const T) -> bool { *self >= *other }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> Ord for *mut T {
        #[inline]
        fn cmp(&self, other: &*mut T) -> Ordering {
            if self < other {
                Less
            } else if self == other {
                Equal
            } else {
                Greater
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: ?Sized> PartialOrd for *mut T {
        #[inline]
        fn partial_cmp(&self, other: &*mut T) -> Option<Ordering> {
            Some(self.cmp(other))
        }

        #[inline]
        fn lt(&self, other: &*mut T) -> bool { *self < *other }

        #[inline]
        fn le(&self, other: &*mut T) -> bool { *self <= *other }

        #[inline]
        fn gt(&self, other: &*mut T) -> bool { *self > *other }

        #[inline]
        fn ge(&self, other: &*mut T) -> bool { *self >= *other }
    }

    /// A wrapper around a raw non-null `*mut T` that indicates that the possessor
    /// of this wrapper owns the referent. This in turn implies that the
    /// `Unique<T>` is `Send`/`Sync` if `T` is `Send`/`Sync`, unlike a raw
    /// `*mut T` (which conveys no particular ownership semantics).  It
    /// also implies that the referent of the pointer should not be
    /// modified without a unique path to the `Unique` reference. Useful
    /// for building abstractions like `Vec<T>` or `Box<T>`, which
    /// internally use raw pointers to manage the memory that they own.
    #[allow(missing_debug_implementations)]
    #[unstable(feature = "unique", reason = "needs an RFC to flesh out design",
               issue = "27730")]
    pub struct Unique<T: ?Sized> {
        pointer: NonZero<*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 = "unique", issue = "27730")]
    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 = "unique", issue = "27730")]
    unsafe impl<T: Sync + ?Sized> Sync for Unique<T> { }

    #[unstable(feature = "unique", issue = "27730")]
    impl<T: ?Sized> Unique<T> {
        /// Creates a new `Unique`.
        ///
        /// # Safety
        ///
        /// `ptr` must be non-null.
        pub const unsafe fn new(ptr: *mut T) -> Unique<T> {
            Unique { pointer: NonZero::new(ptr), _marker: PhantomData }
        }

        /// Dereferences the content.
        pub unsafe fn get(&self) -> &T {
            &**self.pointer
        }

        /// Mutably dereferences the content.
        pub unsafe fn get_mut(&mut self) -> &mut T {
            &mut ***self
        }
    }

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

    #[unstable(feature = "unique", issue= "27730")]
    impl<T:?Sized> Deref for Unique<T> {
        type Target = *mut T;

        #[inline]
        fn deref(&self) -> &*mut T {
            unsafe { mem::transmute(&*self.pointer) }
        }
    }

    #[unstable(feature = "unique", issue = "27730")]
    impl<T> fmt::Pointer for Unique<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Pointer::fmt(&*self.pointer, f)
        }
    }

    /// A wrapper around a raw non-null `*mut T` that indicates that the possessor
    /// of this wrapper has shared ownership of the referent. Useful for
    /// building abstractions like `Rc<T>` or `Arc<T>`, which internally
    /// use raw pointers to manage the memory that they own.
    #[allow(missing_debug_implementations)]
    #[unstable(feature = "shared", reason = "needs an RFC to flesh out design",
               issue = "27730")]
    pub struct Shared<T: ?Sized> {
        pointer: NonZero<*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>,
    }

    /// `Shared` pointers are not `Send` because the data they reference may be aliased.
    // NB: This impl is unnecessary, but should provide better error messages.
    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> !Send for Shared<T> { }

    /// `Shared` pointers are not `Sync` because the data they reference may be aliased.
    // NB: This impl is unnecessary, but should provide better error messages.
    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> !Sync for Shared<T> { }

    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> Shared<T> {
        /// Creates a new `Shared`.
        ///
        /// # Safety
        ///
        /// `ptr` must be non-null.
        pub unsafe fn new(ptr: *const T) -> Self {
            Shared { pointer: NonZero::new(ptr), _marker: PhantomData }
        }
    }

    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> Shared<T> {
        /// Acquires the underlying pointer as a `*mut` pointer.
        pub unsafe fn as_mut_ptr(&self) -> *mut T {
            **self as _
        }
    }

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

    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> Copy for Shared<T> { }

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

    #[unstable(feature = "shared", issue = "27730")]
    impl<T: ?Sized> Deref for Shared<T> {
        type Target = *const T;

        #[inline]
        fn deref(&self) -> &*const T {
            unsafe { mem::transmute(&*self.pointer) }
        }
    }

    #[unstable(feature = "shared", issue = "27730")]
    impl<T> fmt::Pointer for Shared<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Pointer::fmt(&*self.pointer, f)
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)