Struct fuse::sys::FsOptions

#[repr(transparent)]
pub struct FsOptions(<FsOptions as PublicFlags>::Internal);

A bitfield passed in as a parameter to and returned from the init method of the FileSystem trait.

Tuple Fields

0: <FsOptions as PublicFlags>::Internal

Implementations

impl FsOptions

pub const ASYNC_READ: Self = _

Indicates that the filesystem supports asynchronous read requests.

If this capability is not requested/available, the kernel will ensure that there is at most one pending read request per file-handle at any time, and will attempt to order read requests by increasing offset.

This feature is enabled by default when supported by the kernel.

pub const POSIX_LOCKS: Self = _

Indicates that the filesystem supports “remote” locking.

This feature is not enabled by default and should only be set if the filesystem implements the getlk and setlk methods of the FileSystem trait.

pub const FILE_OPS: Self = _

Kernel sends file handle for fstat, etc… (not yet supported).

pub const ATOMIC_O_TRUNC: Self = _

Indicates that the filesystem supports the O_TRUNC open flag. If disabled, and an application specifies O_TRUNC, fuse first calls setattr to truncate the file and then calls open with O_TRUNC filtered out.

This feature is enabled by default when supported by the kernel.

pub const EXPORT_SUPPORT: Self = _

Indicates that the filesystem supports lookups of “.” and “..”.

This feature is disabled by default.

pub const BIG_WRITES: Self = _

FileSystem can handle write size larger than 4kB.

pub const DONT_MASK: Self = _

Indicates that the kernel should not apply the umask to the file mode on create operations.

This feature is disabled by default.

pub const SPLICE_WRITE: Self = _

Indicates that the server should try to use splice(2) when writing to the fuse device. This may improve performance.

This feature is not currently supported.

pub const SPLICE_MOVE: Self = _

Indicates that the server should try to move pages instead of copying when writing to / reading from the fuse device. This may improve performance.

This feature is not currently supported.

pub const SPLICE_READ: Self = _

Indicates that the server should try to use splice(2) when reading from the fuse device. This may improve performance.

This feature is not currently supported.

pub const FLOCK_LOCKS: Self = _

If set, then calls to flock will be emulated using POSIX locks and must then be handled by the filesystem’s setlock() handler.

If not set, flock calls will be handled by the FUSE kernel module internally (so any access that does not go through the kernel cannot be taken into account).

This feature is disabled by default.

pub const HAS_IOCTL_DIR: Self = _

Indicates that the filesystem supports ioctl’s on directories.

This feature is enabled by default when supported by the kernel.

pub const AUTO_INVAL_DATA: Self = _

Traditionally, while a file is open the FUSE kernel module only asks the filesystem for an update of the file’s attributes when a client attempts to read beyond EOF. This is unsuitable for e.g. network filesystems, where the file contents may change without the kernel knowing about it.

If this flag is set, FUSE will check the validity of the attributes on every read. If the attributes are no longer valid (i.e., if the attribute timeout has expired) then FUSE will first send another getattr request. If the new mtime differs from the previous value, any cached file contents will be invalidated as well.

This flag should always be set when available. If all file changes go through the kernel, attribute validity should be set to a very large number to avoid unnecessary getattr() calls.

This feature is enabled by default when supported by the kernel.

pub const DO_READDIRPLUS: Self = _

Indicates that the filesystem supports readdirplus.

The feature is not enabled by default and should only be set if the filesystem implements the readdirplus method of the FileSystem trait.

pub const READDIRPLUS_AUTO: Self = _

Indicates that the filesystem supports adaptive readdirplus.

If DO_READDIRPLUS is not set, this flag has no effect.

If DO_READDIRPLUS is set and this flag is not set, the kernel will always issue readdirplus() requests to retrieve directory contents.

If DO_READDIRPLUS is set and this flag is set, the kernel will issue both readdir() and readdirplus() requests, depending on how much information is expected to be required.

This feature is not enabled by default and should only be set if the file system implements both the readdir and readdirplus methods of the FileSystem trait.

pub const ASYNC_DIO: Self = _

Indicates that the filesystem supports asynchronous direct I/O submission.

If this capability is not requested/available, the kernel will ensure that there is at most one pending read and one pending write request per direct I/O file-handle at any time.

This feature is enabled by default when supported by the kernel.

pub const WRITEBACK_CACHE: Self = _

Indicates that writeback caching should be enabled. This means that individual write request may be buffered and merged in the kernel before they are sent to the file system.

This feature is disabled by default.

pub const ZERO_MESSAGE_OPEN: Self = _

Indicates support for zero-message opens. If this flag is set in the capable parameter of the init trait method, then the file system may return ENOSYS from the open() handler to indicate success. Further attempts to open files will be handled in the kernel. (If this flag is not set, returning ENOSYS will be treated as an error and signaled to the caller).

Setting (or not setting) the field in the FsOptions returned from the init method has no effect.

pub const PARALLEL_DIROPS: Self = _

Indicates support for parallel directory operations. If this flag is unset, the FUSE kernel module will ensure that lookup() and readdir() requests are never issued concurrently for the same directory.

This feature is enabled by default when supported by the kernel.

pub const HANDLE_KILLPRIV: Self = _

Indicates that the file system is responsible for unsetting setuid and setgid bits when a file is written, truncated, or its owner is changed.

This feature is enabled by default when supported by the kernel.

pub const POSIX_ACL: Self = _

Indicates support for POSIX ACLs.

If this feature is enabled, the kernel will cache and have responsibility for enforcing ACLs. ACL will be stored as xattrs and passed to userspace, which is responsible for updating the ACLs in the filesystem, keeping the file mode in sync with the ACL, and ensuring inheritance of default ACLs when new filesystem nodes are created. Note that this requires that the file system is able to parse and interpret the xattr representation of ACLs.

Enabling this feature implicitly turns on the default_permissions mount option (even if it was not passed to mount(2)).

This feature is disabled by default.

pub const CACHE_SYMLINKS: Self = _

Indicates that the kernel may cache responses to readlink calls.

pub const ZERO_MESSAGE_OPENDIR: Self = _

Indicates support for zero-message opens for directories. If this flag is set in the capable parameter of the init trait method, then the file system may return ENOSYS from the opendir() handler to indicate success. Further attempts to open directories will be handled in the kernel. (If this flag is not set, returning ENOSYS will be treated as an error and signaled to the caller).

Setting (or not setting) the field in the FsOptions returned from the init method has no effect.

pub const EXPLICIT_INVAL_DATA: Self = _

Indicates support for invalidating cached pages only on explicit request.

If this flag is set in the capable parameter of the init trait method, then the FUSE kernel module supports invalidating cached pages only on explicit request by the filesystem.

By setting this flag in the return value of the init trait method, the filesystem is responsible for invalidating cached pages through explicit requests to the kernel.

Note that setting this flag does not prevent the cached pages from being flushed by OS itself and/or through user actions.

Note that if both EXPLICIT_INVAL_DATA and AUTO_INVAL_DATA are set in the capable parameter of the init trait method then AUTO_INVAL_DATA takes precedence.

This feature is disabled by default.

pub const MAP_ALIGNMENT: Self = _

Indicates that the map_alignment field of the InitOut struct is valid.

The MAP_ALIGNMENT field is used by the FUSE kernel driver to ensure that its DAX mapping requests are pagesize-aligned. This field automatically set by the server and this feature is enabled by default.

pub const MAX_PAGES: Self = _

Indicates that the max_pages field of the InitOut struct is valid.

This field is used by the kernel driver to determine the maximum number of pages that may be used for any read or write requests.

pub const INIT_EXT: Self = _

Indicates that InitIn/InitOut struct is extended to hold additional flags.

pub const SECURITY_CONTEXT: Self = _

Indicates support for sending the security context with creation requests.

impl FsOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FsOptions

pub const fn iter(&self) -> Iter<FsOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FsOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for FsOptions

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = FsOptions

The resulting type after applying the & operator.

impl BitAndAssign for FsOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for FsOptions

fn bitor(self, other: FsOptions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = FsOptions

The resulting type after applying the | operator.

impl BitOrAssign for FsOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for FsOptions

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = FsOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for FsOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for FsOptions

fn clone(&self) -> FsOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Extend<FsOptions> for FsOptions

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

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 Flags for FsOptions

const FLAGS: &'static [Flag<FsOptions>] = _

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> FsOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<FsOptions> for FsOptions

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for FsOptions

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for FsOptions

type Item = FsOptions

The type of the elements being iterated over.

type IntoIter = Iter<FsOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for FsOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = FsOptions

The resulting type after applying the ! operator.

impl Octal for FsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for FsOptions

fn cmp(&self, other: &FsOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FsOptions

fn eq(&self, other: &FsOptions) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FsOptions

fn partial_cmp(&self, other: &FsOptions) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl PublicFlags for FsOptions

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for FsOptions

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FsOptions

The resulting type after applying the - operator.

impl SubAssign for FsOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for FsOptions

impl Eq for FsOptions

impl StructuralPartialEq for FsOptions