Struct fuse_backend_rs::abi::fuse_abi::FsOptions

pub struct FsOptions { /* private fields */ }

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

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 ABORT_ERROR: Self = _

Indicates support for fuse device abort error.

If this feature is enabled, the kernel will return ECONNABORTED to daemon when a fuse connection is aborted. Otherwise, ENODEV is returned.

This feature is enabled by default.

pub const MAX_PAGES: Self = _

Indicate support for max number of req pages negotiation during INIT request handling.

If this feature is enabled, FUSE INIT response init_out.max_pages will contain the max number of req pages.

This feature is enabled by default.

pub const CACHE_SYMLINKS: Self = _

Indicate support for kernel caching symlinks.

If this feature is enabled, the kernel will cache symlink contents.

This feature is enabled by default.

pub const ZERO_MESSAGE_OPENDIR: 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 opendir() 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.

This feature is enabled by default.

pub const EXPLICIT_INVAL_DATA: Self = _

Indicates to kernel that it is fully responsible for data cache invalidation, then the kernel won’t invalidate files data cache on size change and only truncate that cache to new size in case the size decreased.

If this feature is enabled, FileSystem should notify kernel when a file’s data is changed outside of fuse.

This feature is enabled by default.

pub const MAP_ALIGNMENT: Self = _

Indicate support for byte alignment negotiation during INIT request handling.

If this feature is enabled, the INIT response init_out.map_alignment contains byte alignment for foffset and moffset fields in fuse_setupmapping_out and fuse_removemapping_one.

This feature is enabled by default.

pub const SUBMOUNTS: Self = _

Kernel supports the ATTR_SUBMOUNT flag.

pub const HANDLE_KILLPRIV_V2: Self = _

Filesystem responsible for clearing security.capability xattr and setuid/setgid bits.

1. clear “security.capability” on write, truncate and chown unconditionally
2. sgid is cleared only if group executable bit is set
3. clear suid/sgid when one of the following is true: -. setattr has FATTR_SIZE and FATTR_KILL_SUIDGID set. -. setattr has FATTR_UID or FATTR_GID -. open has O_TRUNC and FOPEN_IN_KILL_SUIDGID -. create has O_TRUNC and FOPEN_IN_KILL_SUIDGID flag set. -. write has WRITE_KILL_PRIV

pub const PERFILE_DAX: Self = _

Indicates whether the guest kernel enable per-file dax

If this feature is enabled, filesystem will notify guest kernel whether file enable DAX by EntryOut.Attr.flags of inode when lookup

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) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> 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: u32) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> 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.

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.

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.

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.

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.

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

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

Formats the value using the given formatter.

impl BitAnd<FsOptions> for FsOptions

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

Returns the intersection between the two sets of flags.

type Output = FsOptions

The resulting type after applying the & operator.

impl BitAndAssign<FsOptions> for FsOptions

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<FsOptions> for FsOptions

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

Returns the union of the two sets of flags.

type Output = FsOptions

The resulting type after applying the | operator.

impl BitOrAssign<FsOptions> for FsOptions

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<FsOptions> for FsOptions

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

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

type Output = FsOptions

The resulting type after applying the ^ operator.

impl BitXorAssign<FsOptions> for FsOptions

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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)

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

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

Creates a value from an iterator.

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 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

Returns the complement of this set of flags.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<FsOptions> 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<FsOptions> 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 Sub<FsOptions> for FsOptions

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

Returns the set difference of the two sets of flags.

type Output = FsOptions

The resulting type after applying the - operator.

impl SubAssign<FsOptions> for FsOptions

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

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

impl StructuralPartialEq for FsOptions