Struct nix::fcntl::FallocateFlags

pub struct FallocateFlags { /* fields hidden */ }
Documentation

Mode argument flags for fallocate determining operation performed on a given range.

Implementations

impl FallocateFlags
const FALLOC_FL_KEEP_SIZE: Self = _

File size is not changed.

offset + len can be greater than file size.

const FALLOC_FL_PUNCH_HOLE: Self = _

Deallocates space by creating a hole.

Must be ORed with FALLOC_FL_KEEP_SIZE. Byte range starts at offset and continues for len bytes.

const FALLOC_FL_COLLAPSE_RANGE: Self = _

Removes byte range from a file without leaving a hole.

Byte range to collapse starts at offset and continues for len bytes.

const FALLOC_FL_ZERO_RANGE: Self = _

Zeroes space in specified byte range.

Byte range starts at offset and continues for len bytes.

const FALLOC_FL_INSERT_RANGE: Self = _

Increases file space by inserting a hole within the file size.

Does not overwrite existing data. Hole starts at offset and continues for len bytes.

const FALLOC_FL_UNSHARE_RANGE: Self = _

Shared file data extants are made private to the file.

Gaurantees that a subsequent write will not fail due to lack of space.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&Self) -> c_int

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: c_int) -> $crate::_core::option::Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_int) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: c_int) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&Self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&Self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&Self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&Self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut Self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut Self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut Self, other: Self)

Toggles the specified flags in-place.

pub fn set(
    &mut Self,
    other: Self,
    value: bool
)

Inserts or removes the specified flags depending on the passed value.

#[must_use]
pub const fn intersection(Self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

#[must_use]
pub const fn union(Self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

#[must_use]
pub const fn difference(Self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

#[must_use]
pub const fn symmetric_difference(Self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

#[must_use]
pub const fn complement(Self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl BitAnd<FallocateFlags> for FallocateFlags
fn bitand(Self, other: Self) -> Self

Returns the intersection between the two sets of flags.

impl BitAndAssign<FallocateFlags> for FallocateFlags
fn bitand_assign(&mut Self, other: Self)

Disables all flags disabled in the set.

impl BitOr<FallocateFlags> for FallocateFlags
fn bitor(Self, other: FallocateFlags) -> Self

Returns the union of the two sets of flags.

impl BitOrAssign<FallocateFlags> for FallocateFlags
fn bitor_assign(&mut Self, other: Self)

Adds the set of flags.

impl BitXor<FallocateFlags> for FallocateFlags
fn bitxor(Self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<FallocateFlags> for FallocateFlags
fn bitxor_assign(&mut Self, other: Self)

Toggles the set of flags.

impl Clone for FallocateFlags
fn clone(&Self) -> FallocateFlags
impl Copy for FallocateFlags
impl Eq for FallocateFlags
impl Extend<FallocateFlags> for FallocateFlags
fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)
impl FromIterator<FallocateFlags> for FallocateFlags
fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Self
impl Hash for FallocateFlags
fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()
impl Not for FallocateFlags
fn not(Self) -> Self

Returns the complement of this set of flags.

impl Ord for FallocateFlags
fn cmp(&Self, other: &FallocateFlags) -> $crate::cmp::Ordering
impl PartialEq<FallocateFlags> for FallocateFlags
fn eq(&Self, other: &FallocateFlags) -> bool
fn ne(&Self, other: &FallocateFlags) -> bool
impl Sub<FallocateFlags> for FallocateFlags
fn sub(Self, other: Self) -> Self

Returns the set difference of the two sets of flags.

impl SubAssign<FallocateFlags> for FallocateFlags
fn sub_assign(&mut Self, other: Self)

Disables all flags enabled in the set.

Auto Trait Implementations

impl Send for FallocateFlags
impl Sync for FallocateFlags
impl Unpin for FallocateFlags

Blanket Implementations

impl<T> Any for T
where
    T: 'static + ?Sized,
fn type_id(&Self) -> TypeId
impl<T> Borrow<T> for T
where
    T: ?Sized,
fn borrow(&Self) -> &T
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T
impl<T> From<T> for T
fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where
    U: From<T>,
fn into(Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where
    T: Clone,
type Owned = T
fn to_owned(&Self) -> T
fn clone_into(&Self, target: &mut T)
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>