Struct OpenFlags

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

DEPRECATED - Use Flags instead.

Implementations

impl OpenFlags

pub const RIGHT_READABLE: OpenFlags

Can read from target object.

pub const RIGHT_WRITABLE: OpenFlags

Can write to target object.

pub const RIGHT_EXECUTABLE: OpenFlags

Connection can map target object executable.

pub const CREATE: OpenFlags

Create the object if it doesn’t exist.

pub const CREATE_IF_ABSENT: OpenFlags

(with Create) Fail if the object already exists.

pub const TRUNCATE: OpenFlags

Truncate the object before usage.

pub const DIRECTORY: OpenFlags

Assert that the object to be opened is a directory. Return an error if the target object is not a directory.

pub const APPEND: OpenFlags

Seek to the end of the object before all writes.

pub const NODE_REFERENCE: OpenFlags

Open a reference to the object, not the object itself. It is ONLY valid to pass the following flags together with NODE_REFERENCE:

• DIRECTORY
• NOT_DIRECTORY
• DESCRIBE otherwise an error is returned. If an object is opened or cloned using this method, the resulting connection does not carry any permission flags. The resulting connection allows a limited set of operations: GetAttr, Clone, Close, Describe, and GetFlags. The connection will speak the Node protocol. Calling SetAttr or SetFlags will result in ZX_ERR_BAD_HANDLE.

pub const DESCRIBE: OpenFlags

Requests that an “OnOpen” event is sent to the interface request.

The event will contain a non-null NodeInfoDeprecated if the open/clone is successful. This can be used to open a protocol that does not compose fuchsia.io/Node; the event is sent as if the protocol is fuchsia.io/Node and then the target protocol is used exclusively.

pub const POSIX_WRITABLE: OpenFlags

Specify this flag to request POSIX-compatibility with respect to write permission handling. Currently, it affects permission handling specifically during Open:

• If the target path is a directory, the rights on the new connection expand to include WRITABLE if and only if the current connection and all intermediate mount points are writable.
• Otherwise, this flag is ignored. It is an access denied error to request more rights than those on the current connection, or any intermediate mount points.

If this flag is omitted, opening always uses the requested rights, failing the operation with access denied error if requested rights exceeds the rights attached to the current connection.

If the requesting connection is read-only and the requested rights are read-only, the flag may be ignored by the server, and is not forwarded downstream. This is an implementation detail, necessary to enforce hierarchical permissions across mount points, and should have no effect on the expected behavior for clients.

pub const POSIX_EXECUTABLE: OpenFlags

Specify this flag to request POSIX-compatibility with respect to execute permission handling. Currently, it affects permission handling specifically during Open:

• If the target path is a directory, the rights on the new connection expand to include EXECUTABLE if and only if the current connection and all intermediate mount points are executable.
• Otherwise, this flag is ignored. It is an access denied error to request more rights than those on the current connection, or any intermediate mount points.

If this flag is omitted, opening always uses the requested rights, failing the operation with access denied error if requested rights exceeds the rights attached to the current connection.

If the requesting connection is read-only and the requested rights are read-only, the flag may be ignored by the server, and is not forwarded downstream. This is an implementation detail, necessary to enforce hierarchical permissions across mount points, and should have no effect on the expected behavior for clients.

pub const NOT_DIRECTORY: OpenFlags

Assert that the object to be opened is not a directory. Return an error if the target object is a directory.

pub const CLONE_SAME_RIGHTS: OpenFlags

When used during clone, the new connection inherits the rights on the source connection, regardless if it is a file or directory. Otherwise, clone attempts to use the requested rights. It is invalid to pass any of the RIGHT_* flags together with OpenFlags.CLONE_SAME_RIGHTS.

pub const BLOCK_DEVICE: OpenFlags

Open the target object as a block device.

impl OpenFlags

pub const fn empty() -> OpenFlags

Get a flags value with all bits unset.

pub const fn all() -> OpenFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

pub const fn from_bits(bits: u32) -> Option<OpenFlags>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u32) -> OpenFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> OpenFlags

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub const fn complement(self) -> OpenFlags

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

impl OpenFlags

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

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

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 OpenFlags

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

Formats the value using the given formatter.

impl BitAnd for OpenFlags

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

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

type Output = OpenFlags

The resulting type after applying the & operator.

impl BitAndAssign for OpenFlags

fn bitand_assign(&mut self, other: OpenFlags)

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

impl BitOr for OpenFlags

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

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

type Output = OpenFlags

The resulting type after applying the | operator.

impl BitOrAssign for OpenFlags

fn bitor_assign(&mut self, other: OpenFlags)

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

impl BitXor for OpenFlags

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

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

type Output = OpenFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for OpenFlags

fn bitxor_assign(&mut self, other: OpenFlags)

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

impl Clone for OpenFlags

fn clone(&self) -> OpenFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenFlags

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

Formats the value using the given formatter.

impl<D> Decode<OpenFlags, D> for OpenFlags

where D: ResourceDialect,

fn new_empty() -> OpenFlags

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 OpenFlags

fn default() -> OpenFlags

Returns the “default value” for a type.

impl<D> Encode<OpenFlags, D> for OpenFlags

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

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

where T: IntoIterator<Item = OpenFlags>,

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 OpenFlags

const FLAGS: &'static [Flag<OpenFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> OpenFlags

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 contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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

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

where T: IntoIterator<Item = OpenFlags>,

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

impl Hash for OpenFlags

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 OpenFlags

type Item = OpenFlags

The type of the elements being iterated over.

type IntoIter = Iter<OpenFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for OpenFlags

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

Formats the value using the given formatter.

impl Not for OpenFlags

fn not(self) -> OpenFlags

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

type Output = OpenFlags

The resulting type after applying the ! operator.

impl Octal for OpenFlags

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

Formats the value using the given formatter.

impl Ord for OpenFlags

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

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

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

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

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

The resulting type after applying the - operator.

impl SubAssign for OpenFlags

fn sub_assign(&mut self, other: OpenFlags)

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 OpenFlags

type Owned = OpenFlags

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 OpenFlags

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

Formats the value using the given formatter.

impl ValueTypeMarker for OpenFlags

type Borrowed<'a> = OpenFlags

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: &<OpenFlags as TypeMarker>::Owned, ) -> <OpenFlags as ValueTypeMarker>::Borrowed<'_>

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

impl Copy for OpenFlags

impl Eq for OpenFlags

impl StructuralPartialEq for OpenFlags