      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

    #![stable(feature = "metadata_ext", since = "1.1.0")]

    use crate::fs::Metadata;
    use crate::sys_common::AsInner;

    #[allow(deprecated)]
    use crate::os::linux::raw;

    /// OS-specific extensions to [`fs::Metadata`].
    ///
    /// [`fs::Metadata`]: ../../../../std/fs/struct.Metadata.html
    #[stable(feature = "metadata_ext", since = "1.1.0")]
    pub trait MetadataExt {
        /// Gain a reference to the underlying `stat` structure which contains
        /// the raw information returned by the OS.
        ///
        /// The contents of the returned [`stat`] are **not** consistent across
        /// Unix platforms. The `os::unix::fs::MetadataExt` trait contains the
        /// cross-Unix abstractions contained within the raw stat.
        ///
        /// [`stat`]: ../../../../std/os/linux/raw/struct.stat.html
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     let stat = meta.as_raw_stat();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext", since = "1.1.0")]
        #[rustc_deprecated(
            since = "1.8.0",
            reason = "other methods of this trait are now prefered"
        )]
        #[allow(deprecated)]
        fn as_raw_stat(&self) -> &raw::stat;

        /// Returns the device ID on which this file resides.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_dev());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_dev(&self) -> u64;
        /// Returns the inode number.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_ino());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_ino(&self) -> u64;
        /// Returns the file type and mode.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_mode());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_mode(&self) -> u32;
        /// Returns the number of hard links to file.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_nlink());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_nlink(&self) -> u64;
        /// Returns the user ID of the file owner.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_uid());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_uid(&self) -> u32;
        /// Returns the group ID of the file owner.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_gid());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_gid(&self) -> u32;
        /// Returns the device ID that this file represents. Only relevant for special file.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_rdev());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_rdev(&self) -> u64;
        /// Returns the size of the file (if it is a regular file or a symbolic link) in bytes.
        ///
        /// The size of a symbolic link is the length of the pathname it contains,
        /// without a terminating null byte.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_size());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_size(&self) -> u64;
        /// Returns the last access time of the file, in seconds since Unix Epoch.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_atime());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_atime(&self) -> i64;
        /// Returns the last access time of the file, in nanoseconds since [`st_atime`].
        ///
        /// [`st_atime`]: #tymethod.st_atime
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_atime_nsec());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_atime_nsec(&self) -> i64;
        /// Returns the last modification time of the file, in seconds since Unix Epoch.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_mtime());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_mtime(&self) -> i64;
        /// Returns the last modification time of the file, in nanoseconds since [`st_mtime`].
        ///
        /// [`st_mtime`]: #tymethod.st_mtime
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_mtime_nsec());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_mtime_nsec(&self) -> i64;
        /// Returns the last status change time of the file, in seconds since Unix Epoch.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_ctime());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_ctime(&self) -> i64;
        /// Returns the last status change time of the file, in nanoseconds since [`st_ctime`].
        ///
        /// [`st_ctime`]: #tymethod.st_ctime
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_ctime_nsec());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_ctime_nsec(&self) -> i64;
        /// Returns the "preferred" blocksize for efficient filesystem I/O.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_blksize());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_blksize(&self) -> u64;
        /// Returns the number of blocks allocated to the file, 512-byte units.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::fs;
        /// use std::io;
        /// use std::os::linux::fs::MetadataExt;
        ///
        /// fn main() -> io::Result<()> {
        ///     let meta = fs::metadata("some_file")?;
        ///     println!("{}", meta.st_blocks());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "metadata_ext2", since = "1.8.0")]
        fn st_blocks(&self) -> u64;
    }

    #[stable(feature = "metadata_ext", since = "1.1.0")]
    impl MetadataExt for Metadata {
        #[allow(deprecated)]
        fn as_raw_stat(&self) -> &raw::stat {
            unsafe {
                &*(self.as_inner().as_inner() as *const libc::stat64
                                              as *const raw::stat)
            }
        }
        fn st_dev(&self) -> u64 {
            self.as_inner().as_inner().st_dev as u64
        }
        fn st_ino(&self) -> u64 {
            self.as_inner().as_inner().st_ino as u64
        }
        fn st_mode(&self) -> u32 {
            self.as_inner().as_inner().st_mode as u32
        }
        fn st_nlink(&self) -> u64 {
            self.as_inner().as_inner().st_nlink as u64
        }
        fn st_uid(&self) -> u32 {
            self.as_inner().as_inner().st_uid as u32
        }
        fn st_gid(&self) -> u32 {
            self.as_inner().as_inner().st_gid as u32
        }
        fn st_rdev(&self) -> u64 {
            self.as_inner().as_inner().st_rdev as u64
        }
        fn st_size(&self) -> u64 {
            self.as_inner().as_inner().st_size as u64
        }
        fn st_atime(&self) -> i64 {
            self.as_inner().as_inner().st_atime as i64
        }
        fn st_atime_nsec(&self) -> i64 {
            self.as_inner().as_inner().st_atime_nsec as i64
        }
        fn st_mtime(&self) -> i64 {
            self.as_inner().as_inner().st_mtime as i64
        }
        fn st_mtime_nsec(&self) -> i64 {
            self.as_inner().as_inner().st_mtime_nsec as i64
        }
        fn st_ctime(&self) -> i64 {
            self.as_inner().as_inner().st_ctime as i64
        }
        fn st_ctime_nsec(&self) -> i64 {
            self.as_inner().as_inner().st_ctime_nsec as i64
        }
        fn st_blksize(&self) -> u64 {
            self.as_inner().as_inner().st_blksize as u64
        }
        fn st_blocks(&self) -> u64 {
            self.as_inner().as_inner().st_blocks as u64
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)