Struct nix::sys::sendfile::SfFlags

[+] Show declaration

pub struct SfFlags { /* fields omitted */ }

[−] Expand description

Configuration options for sendfile.

Implementations

impl SfFlags[−]

pub const SF_NODISKIO: SfFlags[−][−]

Causes sendfile to return EBUSY instead of blocking when attempting to read a busy page.

pub const SF_SYNC: SfFlags[−][−]

Causes sendfile to sleep until the network stack releases its reference to the VM pages read. When sendfile returns, the data is not guaranteed to have been sent, but it is safe to modify the file.

pub const SF_USER_READAHEAD: SfFlags[−][−]

Causes sendfile to cache exactly the number of pages specified in the readahead parameter, disabling caching heuristics.

pub const SF_NOCACHE: SfFlags[−][−]

Causes sendfile not to cache the data read.

pub const fn empty() -> SfFlags[−]

Returns an empty set of flags

pub const fn all() -> SfFlags[−]

Returns the set containing all flags.

pub const fn bits(&self) -> c_int[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<SfFlags>[−]

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) -> SfFlags[−]

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> SfFlags[−]

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

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: SfFlags) -> bool[−]

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

pub const fn contains(&self, other: SfFlags) -> bool[−]

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

pub fn insert(&mut self, other: SfFlags)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SfFlags)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SfFlags)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: SfFlags, value: bool)[−]

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

Trait Implementations

impl Binary for SfFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl BitAnd<SfFlags> for SfFlags[+]

type Output = SfFlags

The resulting type after applying the & operator.

fn bitand(self, other: SfFlags) -> SfFlags[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<SfFlags> for SfFlags[+]

fn bitand_assign(&mut self, other: SfFlags)[−]

Disables all flags disabled in the set.

impl BitOr<SfFlags> for SfFlags[+]

type Output = SfFlags

The resulting type after applying the | operator.

fn bitor(self, other: SfFlags) -> SfFlags[−]

Returns the union of the two sets of flags.

impl BitOrAssign<SfFlags> for SfFlags[+]

fn bitor_assign(&mut self, other: SfFlags)[−]

Adds the set of flags.

impl BitXor<SfFlags> for SfFlags[+]

type Output = SfFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: SfFlags) -> SfFlags[−]

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

impl BitXorAssign<SfFlags> for SfFlags[+]

fn bitxor_assign(&mut self, other: SfFlags)[−]

Toggles the set of flags.

impl Clone for SfFlags[+]

[+] Show hidden undocumented items

fn clone(&self) -> SfFlags[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for SfFlags

impl Debug for SfFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for SfFlags

impl Extend<SfFlags> for SfFlags[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = SfFlags>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)[−]

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)[−]

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<SfFlags> for SfFlags[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = SfFlags>>(iterator: T) -> SfFlags[−]

Creates a value from an iterator.

impl Hash for SfFlags[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given [Hasher].

impl LowerHex for SfFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Not for SfFlags[+]

type Output = SfFlags

The resulting type after applying the ! operator.

fn not(self) -> SfFlags[−]

Returns the complement of this set of flags.

impl Octal for SfFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Ord for SfFlags[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &SfFlags) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SfFlags> for SfFlags[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SfFlags) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SfFlags) -> bool[−]

This method tests for !=.

impl PartialOrd<SfFlags> for SfFlags[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &SfFlags) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SfFlags) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SfFlags) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SfFlags) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SfFlags) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SfFlags

impl StructuralPartialEq for SfFlags

impl Sub<SfFlags> for SfFlags[+]

type Output = SfFlags

The resulting type after applying the - operator.

fn sub(self, other: SfFlags) -> SfFlags[−]

Returns the set difference of the two sets of flags.

impl SubAssign<SfFlags> for SfFlags[+]

fn sub_assign(&mut self, other: SfFlags)[−]

Disables all flags enabled in the set.

impl UpperHex for SfFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.