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
use crate::backend::c;
use bitflags::bitflags;
bitflags! {
/// `*_OK` constants for use with [`accessat`].
///
/// [`accessat`]: fn.accessat.html
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct Access: c::c_uint {
/// `R_OK`
const READ_OK = linux_raw_sys::general::R_OK;
/// `W_OK`
const WRITE_OK = linux_raw_sys::general::W_OK;
/// `X_OK`
const EXEC_OK = linux_raw_sys::general::X_OK;
/// `F_OK`
const EXISTS = linux_raw_sys::general::F_OK;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `AT_*` constants for use with [`openat`], [`statat`], and other `*at`
/// functions.
///
/// [`openat`]: crate::fs::openat
/// [`statat`]: crate::fs::statat
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct AtFlags: c::c_uint {
/// `AT_SYMLINK_NOFOLLOW`
const SYMLINK_NOFOLLOW = linux_raw_sys::general::AT_SYMLINK_NOFOLLOW;
/// `AT_EACCESS`
const EACCESS = linux_raw_sys::general::AT_EACCESS;
/// `AT_REMOVEDIR`
const REMOVEDIR = linux_raw_sys::general::AT_REMOVEDIR;
/// `AT_SYMLINK_FOLLOW`
const SYMLINK_FOLLOW = linux_raw_sys::general::AT_SYMLINK_FOLLOW;
/// `AT_NO_AUTOMOUNT`
const NO_AUTOMOUNT = linux_raw_sys::general::AT_NO_AUTOMOUNT;
/// `AT_EMPTY_PATH`
const EMPTY_PATH = linux_raw_sys::general::AT_EMPTY_PATH;
/// `AT_STATX_SYNC_AS_STAT`
const STATX_SYNC_AS_STAT = linux_raw_sys::general::AT_STATX_SYNC_AS_STAT;
/// `AT_STATX_FORCE_SYNC`
const STATX_FORCE_SYNC = linux_raw_sys::general::AT_STATX_FORCE_SYNC;
/// `AT_STATX_DONT_SYNC`
const STATX_DONT_SYNC = linux_raw_sys::general::AT_STATX_DONT_SYNC;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `S_I*` constants for use with [`openat`], [`chmodat`], and [`fchmod`].
///
/// [`openat`]: crate::fs::openat
/// [`chmodat`]: crate::fs::chmodat
/// [`fchmod`]: crate::fs::fchmod
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct Mode: RawMode {
/// `S_IRWXU`
const RWXU = linux_raw_sys::general::S_IRWXU;
/// `S_IRUSR`
const RUSR = linux_raw_sys::general::S_IRUSR;
/// `S_IWUSR`
const WUSR = linux_raw_sys::general::S_IWUSR;
/// `S_IXUSR`
const XUSR = linux_raw_sys::general::S_IXUSR;
/// `S_IRWXG`
const RWXG = linux_raw_sys::general::S_IRWXG;
/// `S_IRGRP`
const RGRP = linux_raw_sys::general::S_IRGRP;
/// `S_IWGRP`
const WGRP = linux_raw_sys::general::S_IWGRP;
/// `S_IXGRP`
const XGRP = linux_raw_sys::general::S_IXGRP;
/// `S_IRWXO`
const RWXO = linux_raw_sys::general::S_IRWXO;
/// `S_IROTH`
const ROTH = linux_raw_sys::general::S_IROTH;
/// `S_IWOTH`
const WOTH = linux_raw_sys::general::S_IWOTH;
/// `S_IXOTH`
const XOTH = linux_raw_sys::general::S_IXOTH;
/// `S_ISUID`
const SUID = linux_raw_sys::general::S_ISUID;
/// `S_ISGID`
const SGID = linux_raw_sys::general::S_ISGID;
/// `S_ISVTX`
const SVTX = linux_raw_sys::general::S_ISVTX;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
impl Mode {
/// Construct a `Mode` from the mode bits of the `st_mode` field of a
/// `Mode`.
#[inline]
pub const fn from_raw_mode(st_mode: RawMode) -> Self {
Self::from_bits_truncate(st_mode & !linux_raw_sys::general::S_IFMT)
}
/// Construct an `st_mode` value from a `Mode`.
#[inline]
pub const fn as_raw_mode(self) -> RawMode {
self.bits()
}
}
impl From<RawMode> for Mode {
/// Support conversions from raw mode values to `Mode`.
///
/// ```
/// use rustix::fs::{Mode, RawMode};
/// assert_eq!(Mode::from(0o700), Mode::RWXU);
/// ```
#[inline]
fn from(st_mode: RawMode) -> Self {
Self::from_raw_mode(st_mode)
}
}
impl From<Mode> for RawMode {
/// Support conversions from `Mode` to raw mode values.
///
/// ```
/// use rustix::fs::{Mode, RawMode};
/// assert_eq!(RawMode::from(Mode::RWXU), 0o700);
/// ```
#[inline]
fn from(mode: Mode) -> Self {
mode.as_raw_mode()
}
}
bitflags! {
/// `O_*` constants for use with [`openat`].
///
/// [`openat`]: crate::fs::openat
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct OFlags: c::c_uint {
/// `O_ACCMODE`
const ACCMODE = linux_raw_sys::general::O_ACCMODE;
/// Similar to `ACCMODE`, but just includes the read/write flags, and
/// no other flags.
///
/// On some platforms, `PATH` may be included in `ACCMODE`, when
/// sometimes we really just want the read/write bits. Caution is
/// indicated, as the presence of `PATH` may mean that the read/write
/// bits don't have their usual meaning.
const RWMODE = linux_raw_sys::general::O_RDONLY |
linux_raw_sys::general::O_WRONLY |
linux_raw_sys::general::O_RDWR;
/// `O_APPEND`
const APPEND = linux_raw_sys::general::O_APPEND;
/// `O_CREAT`
#[doc(alias = "CREAT")]
const CREATE = linux_raw_sys::general::O_CREAT;
/// `O_DIRECTORY`
const DIRECTORY = linux_raw_sys::general::O_DIRECTORY;
/// `O_DSYNC`.
const DSYNC = linux_raw_sys::general::O_SYNC;
/// `O_EXCL`
const EXCL = linux_raw_sys::general::O_EXCL;
/// `O_FSYNC`.
const FSYNC = linux_raw_sys::general::O_SYNC;
/// `O_NOFOLLOW`
const NOFOLLOW = linux_raw_sys::general::O_NOFOLLOW;
/// `O_NONBLOCK`
const NONBLOCK = linux_raw_sys::general::O_NONBLOCK;
/// `O_RDONLY`
const RDONLY = linux_raw_sys::general::O_RDONLY;
/// `O_WRONLY`
const WRONLY = linux_raw_sys::general::O_WRONLY;
/// `O_RDWR`
///
/// This is not equal to `RDONLY | WRONLY`. It's a distinct flag.
const RDWR = linux_raw_sys::general::O_RDWR;
/// `O_NOCTTY`
const NOCTTY = linux_raw_sys::general::O_NOCTTY;
/// `O_RSYNC`.
const RSYNC = linux_raw_sys::general::O_SYNC;
/// `O_SYNC`
const SYNC = linux_raw_sys::general::O_SYNC;
/// `O_TRUNC`
const TRUNC = linux_raw_sys::general::O_TRUNC;
/// `O_PATH`
const PATH = linux_raw_sys::general::O_PATH;
/// `O_CLOEXEC`
const CLOEXEC = linux_raw_sys::general::O_CLOEXEC;
/// `O_TMPFILE`
const TMPFILE = linux_raw_sys::general::O_TMPFILE;
/// `O_NOATIME`
const NOATIME = linux_raw_sys::general::O_NOATIME;
/// `O_DIRECT`
const DIRECT = linux_raw_sys::general::O_DIRECT;
/// `O_LARGEFILE`
///
/// Note that rustix and/or libc will automatically set this flag when appropriate on
/// `open(2)` and friends, thus typical users do not need to care about it.
/// It will may be reported in return of `fcntl_getfl`, though.
const LARGEFILE = linux_raw_sys::general::O_LARGEFILE;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `RESOLVE_*` constants for use with [`openat2`].
///
/// [`openat2`]: crate::fs::openat2
#[repr(transparent)]
#[derive(Default, Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct ResolveFlags: u64 {
/// `RESOLVE_NO_XDEV`
const NO_XDEV = linux_raw_sys::general::RESOLVE_NO_XDEV as u64;
/// `RESOLVE_NO_MAGICLINKS`
const NO_MAGICLINKS = linux_raw_sys::general::RESOLVE_NO_MAGICLINKS as u64;
/// `RESOLVE_NO_SYMLINKS`
const NO_SYMLINKS = linux_raw_sys::general::RESOLVE_NO_SYMLINKS as u64;
/// `RESOLVE_BENEATH`
const BENEATH = linux_raw_sys::general::RESOLVE_BENEATH as u64;
/// `RESOLVE_IN_ROOT`
const IN_ROOT = linux_raw_sys::general::RESOLVE_IN_ROOT as u64;
/// `RESOLVE_CACHED` (since Linux 5.12)
const CACHED = linux_raw_sys::general::RESOLVE_CACHED as u64;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `RENAME_*` constants for use with [`renameat_with`].
///
/// [`renameat_with`]: crate::fs::renameat_with
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct RenameFlags: c::c_uint {
/// `RENAME_EXCHANGE`
const EXCHANGE = linux_raw_sys::general::RENAME_EXCHANGE;
/// `RENAME_NOREPLACE`
const NOREPLACE = linux_raw_sys::general::RENAME_NOREPLACE;
/// `RENAME_WHITEOUT`
const WHITEOUT = linux_raw_sys::general::RENAME_WHITEOUT;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
/// `S_IF*` constants for use with [`mknodat`] and [`Stat`]'s `st_mode` field.
///
/// [`mknodat`]: crate::fs::mknodat
/// [`Stat`]: crate::fs::Stat
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum FileType {
/// `S_IFREG`
RegularFile = linux_raw_sys::general::S_IFREG as isize,
/// `S_IFDIR`
Directory = linux_raw_sys::general::S_IFDIR as isize,
/// `S_IFLNK`
Symlink = linux_raw_sys::general::S_IFLNK as isize,
/// `S_IFIFO`
#[doc(alias = "IFO")]
Fifo = linux_raw_sys::general::S_IFIFO as isize,
/// `S_IFSOCK`
Socket = linux_raw_sys::general::S_IFSOCK as isize,
/// `S_IFCHR`
CharacterDevice = linux_raw_sys::general::S_IFCHR as isize,
/// `S_IFBLK`
BlockDevice = linux_raw_sys::general::S_IFBLK as isize,
/// An unknown filesystem object.
Unknown,
}
impl FileType {
/// Construct a `FileType` from the `S_IFMT` bits of the `st_mode` field of
/// a `Stat`.
#[inline]
pub const fn from_raw_mode(st_mode: RawMode) -> Self {
match st_mode & linux_raw_sys::general::S_IFMT {
linux_raw_sys::general::S_IFREG => Self::RegularFile,
linux_raw_sys::general::S_IFDIR => Self::Directory,
linux_raw_sys::general::S_IFLNK => Self::Symlink,
linux_raw_sys::general::S_IFIFO => Self::Fifo,
linux_raw_sys::general::S_IFSOCK => Self::Socket,
linux_raw_sys::general::S_IFCHR => Self::CharacterDevice,
linux_raw_sys::general::S_IFBLK => Self::BlockDevice,
_ => Self::Unknown,
}
}
/// Construct an `st_mode` value from a `FileType`.
#[inline]
pub const fn as_raw_mode(self) -> RawMode {
match self {
Self::RegularFile => linux_raw_sys::general::S_IFREG,
Self::Directory => linux_raw_sys::general::S_IFDIR,
Self::Symlink => linux_raw_sys::general::S_IFLNK,
Self::Fifo => linux_raw_sys::general::S_IFIFO,
Self::Socket => linux_raw_sys::general::S_IFSOCK,
Self::CharacterDevice => linux_raw_sys::general::S_IFCHR,
Self::BlockDevice => linux_raw_sys::general::S_IFBLK,
Self::Unknown => linux_raw_sys::general::S_IFMT,
}
}
/// Construct a `FileType` from the `d_type` field of a `c::dirent`.
#[inline]
pub(crate) const fn from_dirent_d_type(d_type: u8) -> Self {
match d_type as u32 {
linux_raw_sys::general::DT_REG => Self::RegularFile,
linux_raw_sys::general::DT_DIR => Self::Directory,
linux_raw_sys::general::DT_LNK => Self::Symlink,
linux_raw_sys::general::DT_SOCK => Self::Socket,
linux_raw_sys::general::DT_FIFO => Self::Fifo,
linux_raw_sys::general::DT_CHR => Self::CharacterDevice,
linux_raw_sys::general::DT_BLK => Self::BlockDevice,
// linux_raw_sys::general::DT_UNKNOWN |
_ => Self::Unknown,
}
}
}
/// `POSIX_FADV_*` constants for use with [`fadvise`].
///
/// [`fadvise`]: crate::fs::fadvise
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u32)]
pub enum Advice {
/// `POSIX_FADV_NORMAL`
Normal = linux_raw_sys::general::POSIX_FADV_NORMAL,
/// `POSIX_FADV_SEQUENTIAL`
Sequential = linux_raw_sys::general::POSIX_FADV_SEQUENTIAL,
/// `POSIX_FADV_RANDOM`
Random = linux_raw_sys::general::POSIX_FADV_RANDOM,
/// `POSIX_FADV_NOREUSE`
NoReuse = linux_raw_sys::general::POSIX_FADV_NOREUSE,
/// `POSIX_FADV_WILLNEED`
WillNeed = linux_raw_sys::general::POSIX_FADV_WILLNEED,
/// `POSIX_FADV_DONTNEED`
DontNeed = linux_raw_sys::general::POSIX_FADV_DONTNEED,
}
bitflags! {
/// `MFD_*` constants for use with [`memfd_create`].
///
/// [`memfd_create`]: crate::fs::memfd_create
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct MemfdFlags: c::c_uint {
/// `MFD_CLOEXEC`
const CLOEXEC = linux_raw_sys::general::MFD_CLOEXEC;
/// `MFD_ALLOW_SEALING`
const ALLOW_SEALING = linux_raw_sys::general::MFD_ALLOW_SEALING;
/// `MFD_HUGETLB` (since Linux 4.14)
const HUGETLB = linux_raw_sys::general::MFD_HUGETLB;
/// `MFD_NOEXEC_SEAL` (since Linux 6.3)
const NOEXEC_SEAL = linux_raw_sys::general::MFD_NOEXEC_SEAL;
/// `MFD_EXEC` (since Linux 6.3)
const EXEC = linux_raw_sys::general::MFD_EXEC;
/// `MFD_HUGE_64KB`
const HUGE_64KB = linux_raw_sys::general::MFD_HUGE_64KB;
/// `MFD_HUGE_512KB`
const HUGE_512KB = linux_raw_sys::general::MFD_HUGE_512KB;
/// `MFD_HUGE_1MB`
const HUGE_1MB = linux_raw_sys::general::MFD_HUGE_1MB;
/// `MFD_HUGE_2MB`
const HUGE_2MB = linux_raw_sys::general::MFD_HUGE_2MB;
/// `MFD_HUGE_8MB`
const HUGE_8MB = linux_raw_sys::general::MFD_HUGE_8MB;
/// `MFD_HUGE_16MB`
const HUGE_16MB = linux_raw_sys::general::MFD_HUGE_16MB;
/// `MFD_HUGE_32MB`
const HUGE_32MB = linux_raw_sys::general::MFD_HUGE_32MB;
/// `MFD_HUGE_256MB`
const HUGE_256MB = linux_raw_sys::general::MFD_HUGE_256MB;
/// `MFD_HUGE_512MB`
const HUGE_512MB = linux_raw_sys::general::MFD_HUGE_512MB;
/// `MFD_HUGE_1GB`
const HUGE_1GB = linux_raw_sys::general::MFD_HUGE_1GB;
/// `MFD_HUGE_2GB`
const HUGE_2GB = linux_raw_sys::general::MFD_HUGE_2GB;
/// `MFD_HUGE_16GB`
const HUGE_16GB = linux_raw_sys::general::MFD_HUGE_16GB;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `F_SEAL_*` constants for use with [`fcntl_add_seals`] and
/// [`fcntl_get_seals`].
///
/// [`fcntl_add_seals`]: crate::fs::fcntl_add_seals
/// [`fcntl_get_seals`]: crate::fs::fcntl_get_seals
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct SealFlags: u32 {
/// `F_SEAL_SEAL`.
const SEAL = linux_raw_sys::general::F_SEAL_SEAL;
/// `F_SEAL_SHRINK`.
const SHRINK = linux_raw_sys::general::F_SEAL_SHRINK;
/// `F_SEAL_GROW`.
const GROW = linux_raw_sys::general::F_SEAL_GROW;
/// `F_SEAL_WRITE`.
const WRITE = linux_raw_sys::general::F_SEAL_WRITE;
/// `F_SEAL_FUTURE_WRITE` (since Linux 5.1)
const FUTURE_WRITE = linux_raw_sys::general::F_SEAL_FUTURE_WRITE;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `STATX_*` constants for use with [`statx`].
///
/// [`statx`]: crate::fs::statx
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct StatxFlags: u32 {
/// `STATX_TYPE`
const TYPE = linux_raw_sys::general::STATX_TYPE;
/// `STATX_MODE`
const MODE = linux_raw_sys::general::STATX_MODE;
/// `STATX_NLINK`
const NLINK = linux_raw_sys::general::STATX_NLINK;
/// `STATX_UID`
const UID = linux_raw_sys::general::STATX_UID;
/// `STATX_GID`
const GID = linux_raw_sys::general::STATX_GID;
/// `STATX_ATIME`
const ATIME = linux_raw_sys::general::STATX_ATIME;
/// `STATX_MTIME`
const MTIME = linux_raw_sys::general::STATX_MTIME;
/// `STATX_CTIME`
const CTIME = linux_raw_sys::general::STATX_CTIME;
/// `STATX_INO`
const INO = linux_raw_sys::general::STATX_INO;
/// `STATX_SIZE`
const SIZE = linux_raw_sys::general::STATX_SIZE;
/// `STATX_BLOCKS`
const BLOCKS = linux_raw_sys::general::STATX_BLOCKS;
/// `STATX_BASIC_STATS`
const BASIC_STATS = linux_raw_sys::general::STATX_BASIC_STATS;
/// `STATX_BTIME`
const BTIME = linux_raw_sys::general::STATX_BTIME;
/// `STATX_MNT_ID` (since Linux 5.8)
const MNT_ID = linux_raw_sys::general::STATX_MNT_ID;
/// `STATX_DIOALIGN` (since Linux 6.1)
const DIOALIGN = linux_raw_sys::general::STATX_DIOALIGN;
/// `STATX_ALL`
const ALL = linux_raw_sys::general::STATX_ALL;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `FALLOC_FL_*` constants for use with [`fallocate`].
///
/// [`fallocate`]: crate::fs::fallocate
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct FallocateFlags: u32 {
/// `FALLOC_FL_KEEP_SIZE`
const KEEP_SIZE = linux_raw_sys::general::FALLOC_FL_KEEP_SIZE;
/// `FALLOC_FL_PUNCH_HOLE`
const PUNCH_HOLE = linux_raw_sys::general::FALLOC_FL_PUNCH_HOLE;
/// `FALLOC_FL_NO_HIDE_STALE`
const NO_HIDE_STALE = linux_raw_sys::general::FALLOC_FL_NO_HIDE_STALE;
/// `FALLOC_FL_COLLAPSE_RANGE`
const COLLAPSE_RANGE = linux_raw_sys::general::FALLOC_FL_COLLAPSE_RANGE;
/// `FALLOC_FL_ZERO_RANGE`
const ZERO_RANGE = linux_raw_sys::general::FALLOC_FL_ZERO_RANGE;
/// `FALLOC_FL_INSERT_RANGE`
const INSERT_RANGE = linux_raw_sys::general::FALLOC_FL_INSERT_RANGE;
/// `FALLOC_FL_UNSHARE_RANGE`
const UNSHARE_RANGE = linux_raw_sys::general::FALLOC_FL_UNSHARE_RANGE;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
bitflags! {
/// `ST_*` constants for use with [`StatVfs`].
#[repr(transparent)]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct StatVfsMountFlags: u64 {
/// `ST_MANDLOCK`
const MANDLOCK = linux_raw_sys::general::MS_MANDLOCK as u64;
/// `ST_NOATIME`
const NOATIME = linux_raw_sys::general::MS_NOATIME as u64;
/// `ST_NODEV`
const NODEV = linux_raw_sys::general::MS_NODEV as u64;
/// `ST_NODIRATIME`
const NODIRATIME = linux_raw_sys::general::MS_NODIRATIME as u64;
/// `ST_NOEXEC`
const NOEXEC = linux_raw_sys::general::MS_NOEXEC as u64;
/// `ST_NOSUID`
const NOSUID = linux_raw_sys::general::MS_NOSUID as u64;
/// `ST_RDONLY`
const RDONLY = linux_raw_sys::general::MS_RDONLY as u64;
/// `ST_RELATIME`
const RELATIME = linux_raw_sys::general::MS_RELATIME as u64;
/// `ST_SYNCHRONOUS`
const SYNCHRONOUS = linux_raw_sys::general::MS_SYNCHRONOUS as u64;
/// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
const _ = !0;
}
}
/// `LOCK_*` constants for use with [`flock`] and [`fcntl_lock`].
///
/// [`flock`]: crate::fs::flock
/// [`fcntl_lock`]: crate::fs::fcntl_lock
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum FlockOperation {
/// `LOCK_SH`
LockShared = linux_raw_sys::general::LOCK_SH,
/// `LOCK_EX`
LockExclusive = linux_raw_sys::general::LOCK_EX,
/// `LOCK_UN`
Unlock = linux_raw_sys::general::LOCK_UN,
/// `LOCK_SH | LOCK_NB`
NonBlockingLockShared = linux_raw_sys::general::LOCK_SH | linux_raw_sys::general::LOCK_NB,
/// `LOCK_EX | LOCK_NB`
NonBlockingLockExclusive = linux_raw_sys::general::LOCK_EX | linux_raw_sys::general::LOCK_NB,
/// `LOCK_UN | LOCK_NB`
NonBlockingUnlock = linux_raw_sys::general::LOCK_UN | linux_raw_sys::general::LOCK_NB,
}
/// `struct stat` for use with [`statat`] and [`fstat`].
///
/// [`statat`]: crate::fs::statat
/// [`fstat`]: crate::fs::fstat
// On 32-bit, and mips64, Linux's `struct stat64` has a 32-bit `st_mtime` and
// friends, so we use our own struct, populated from `statx` where possible, to
// avoid the y2038 bug.
#[cfg(any(
target_pointer_width = "32",
target_arch = "mips64",
target_arch = "mips64r6"
))]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
#[allow(missing_docs)]
pub struct Stat {
pub st_dev: u64,
pub st_mode: u32,
pub st_nlink: u32,
pub st_uid: u32,
pub st_gid: u32,
pub st_rdev: u64,
pub st_size: i64,
pub st_blksize: u32,
pub st_blocks: u64,
#[deprecated(note = "Use `rustix::fs::StatExt::atime` instead.")]
pub st_atime: u64,
pub st_atime_nsec: u32,
#[deprecated(note = "Use `rustix::fs::StatExt::mtime` instead.")]
pub st_mtime: u64,
pub st_mtime_nsec: u32,
#[deprecated(note = "Use `rustix::fs::StatExt::ctime` instead.")]
pub st_ctime: u64,
pub st_ctime_nsec: u32,
pub st_ino: u64,
}
/// `struct stat` for use with [`statat`] and [`fstat`].
///
/// [`statat`]: crate::fs::statat
/// [`fstat`]: crate::fs::fstat
#[cfg(all(
target_pointer_width = "64",
not(target_arch = "mips64"),
not(target_arch = "mips64r6")
))]
pub type Stat = linux_raw_sys::general::stat;
/// `struct statfs` for use with [`statfs`] and [`fstatfs`].
///
/// [`statfs`]: crate::fs::statfs
/// [`fstatfs`]: crate::fs::fstatfs
#[allow(clippy::module_name_repetitions)]
pub type StatFs = linux_raw_sys::general::statfs64;
/// `struct statvfs` for use with [`statvfs`] and [`fstatvfs`].
///
/// [`statvfs`]: crate::fs::statvfs
/// [`fstatvfs`]: crate::fs::fstatvfs
#[allow(missing_docs)]
pub struct StatVfs {
pub f_bsize: u64,
pub f_frsize: u64,
pub f_blocks: u64,
pub f_bfree: u64,
pub f_bavail: u64,
pub f_files: u64,
pub f_ffree: u64,
pub f_favail: u64,
pub f_fsid: u64,
pub f_flag: StatVfsMountFlags,
pub f_namemax: u64,
}
/// `struct statx` for use with [`statx`].
///
/// [`statx`]: crate::fs::statx
pub type Statx = linux_raw_sys::general::statx;
/// `struct statx_timestamp` for use with [`Statx`].
pub type StatxTimestamp = linux_raw_sys::general::statx_timestamp;
/// `mode_t`
#[cfg(not(any(
target_arch = "x86",
target_arch = "sparc",
target_arch = "avr",
target_arch = "arm",
)))]
pub type RawMode = linux_raw_sys::general::__kernel_mode_t;
/// `mode_t`
#[cfg(any(
target_arch = "x86",
target_arch = "sparc",
target_arch = "avr",
target_arch = "arm",
))]
// Don't use `__kernel_mode_t` since it's `u16` which differs from `st_size`.
pub type RawMode = c::c_uint;
/// `dev_t`
// Within the kernel the `dev_t` is 32-bit, but userspace uses a 64-bit field.
pub type Dev = u64;
/// `__fsword_t`
#[cfg(not(any(target_arch = "mips64", target_arch = "mips64r6")))]
pub type FsWord = linux_raw_sys::general::__fsword_t;
/// `__fsword_t`
#[cfg(any(target_arch = "mips64", target_arch = "mips64r6"))]
pub type FsWord = i64;