Struct Flags

pub struct Flags(/* private fields */);

Flags used to specify how a node should be opened. Note that ranges of bits are reserved for specific use cases:

• Bits 1-16: Permission flags PERM_* (e.g. [Flags.PERM_READ]).
• Bits 17-32: POSIX compatibile O_* flags (e.g. [Flags.FILE_TRUNCATE] or O_TRUNC).
• Bits 33-64: Fuchsia-specific flags.

Implementations

impl Flags

pub const PERM_CONNECT: Flags = _

Allows opening child nodes with [PROTOCOL_SERVICE].

pub const PERM_READ: Flags = _

Read byte contents of a file.

pub const PERM_WRITE: Flags = _

Write byte contents to a file.

pub const PERM_EXECUTE: Flags = _

Execute byte contents of a file.

pub const PERM_GET_ATTRIBUTES: Flags = _

Get/query attributes of a node.

pub const PERM_SET_ATTRIBUTES: Flags = _

Set/update attributes of a node.

pub const PERM_ENUMERATE: Flags = _

Enumerate (list) directory entries.

pub const PERM_TRAVERSE: Flags = _

Allow opening a child node with a node protocol. Must be specified with PERM_ENUMERATE otherwise requests will fail with ZX_ERR_INVALID_ARGS.

pub const PERM_MODIFY: Flags = _

Modify directory entries (create/rename/link/unlink). Must be specified with PERM_ENUMERATE otherwise requests will fail with ZX_ERR_INVALID_ARGS.

pub const PERM_INHERIT_WRITE: Flags = _

Inherit write permissions when available (PERM_WRITE, PERM_SET_ATTRIBUTES, PERM_MODIFY, PERM_ENUMERATE). Servers must ensure this flag is removed if the parent connection lacks any of these rights. See INHERITED_WRITE_PERMISSIONS for the exact set of permissions that will be inherited.

pub const PERM_INHERIT_EXECUTE: Flags = _

Inherit execute permission when available (PERM_EXECUTE). Servers must ensure this flag is removed if the parent connection lacks PERM_EXECUTE.

pub const PROTOCOL_SERVICE: Flags = _

Connect to the underlying protocol if this is a service node. The caller must determine the correct protocol to use (e.g. based on path). Unless used with [PROTOCOL_NODE], specifying other flags with the request will fail with ZX_ERR_INVALID_ARGS.

pub const PROTOCOL_NODE: Flags = _

Connect to the underlying node. Takes precedence over other protocols. If other PROTOCOL_* are specified, they will be used to validate the target node type. Requests will fail with ZX_ERR_INVALID_ARGS if flags other than PROTOCOL_* and [FLAG_SEND_REPRESENTATION] are specified. Equivalent to POSIX O_PATH.

pub const PROTOCOL_DIRECTORY: Flags = _

Caller accepts [fuchsia.io/Directory] protocol. Equivalent to POSIX O_DIRECTORY.

pub const PROTOCOL_FILE: Flags = _

Caller accepts [fuchsia.io/File] protocol.

pub const PROTOCOL_SYMLINK: Flags = _

Caller accepts [fuchsia.io/Symlink] protocol.

pub const FLAG_SEND_REPRESENTATION: Flags = _

Caller requests a [fuchsia.io/Node.OnRepresentation] event on success.

pub const FLAG_MAYBE_CREATE: Flags = _

Create a new object if one doesn’t exist, otherwise open an existing object. If set, a single PROTOCOL_* flag must be set indicating the type of object to create. Equivalent to POSIX O_CREAT.

pub const FLAG_MUST_CREATE: Flags = _

Create a new object if one doesn’t exist, otherwise fail the request with ZX_ERR_ALREADY_EXISTS. If set, a single PROTOCOL_* flag must be set indicating the type of object to create. Takes precedence over [FLAG_CREATE]. Equivalent to POSIX O_EXCL.

pub const FILE_APPEND: Flags = _

Open the file in append mode. The seek pointer will be moved to end-of-file (EOF) before all writes. Equivalent to POSIX O_APPEND.

pub const FILE_TRUNCATE: Flags = _

Truncate the file to zero length upon opening it. Equivalent to POSIX O_TRUNC.

impl Flags

pub const fn empty() -> Flags

Get a flags value with all bits unset.

pub const fn all() -> Flags

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

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: Flags) -> bool

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

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

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

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

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

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

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: Flags)

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

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

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

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

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

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

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

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

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: Flags) -> Flags

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

pub const fn complement(self) -> Flags

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

impl Flags

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

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

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.

impl Flags

pub fn from_bits_allow_unknown(bits: u64) -> Flags

pub fn has_unknown_bits(&self) -> bool

pub fn get_unknown_bits(&self) -> u64

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd for Flags

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

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

type Output = Flags

The resulting type after applying the & operator.

impl BitAndAssign for Flags

fn bitand_assign(&mut self, other: Flags)

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

impl BitOr for Flags

fn bitor(self, other: Flags) -> Flags

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

type Output = Flags

The resulting type after applying the | operator.

impl BitOrAssign for Flags

fn bitor_assign(&mut self, other: Flags)

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

impl BitXor for Flags

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

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

type Output = Flags

The resulting type after applying the ^ operator.

impl BitXorAssign for Flags

fn bitxor_assign(&mut self, other: Flags)

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

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl<D> Decode<Flags, D> for Flags

where D: ResourceDialect,

fn new_empty() -> Flags

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl<D> Encode<Flags, D> for Flags

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Extend<Flags> for Flags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = Flags>,

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 Flags

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

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

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

fn from_iter<T>(iterator: T) -> Flags

where T: IntoIterator<Item = Flags>,

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

impl Hash for Flags

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Flags

type Item = Flags

The type of the elements being iterated over.

type IntoIter = Iter<Flags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Flags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

fn not(self) -> Flags

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

type Output = Flags

The resulting type after applying the ! operator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

fn cmp(&self, other: &Flags) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Flags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Flags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for Flags

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

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

The resulting type after applying the - operator.

impl SubAssign for Flags

fn sub_assign(&mut self, other: Flags)

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

type Owned = Flags

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl ValueTypeMarker for Flags

type Borrowed<'a> = Flags

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<Flags as TypeMarker>::Owned, ) -> <Flags as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for Flags

impl Eq for Flags

impl StructuralPartialEq for Flags