Struct fidl_fuchsia_io::OpenFlags
source · pub struct OpenFlags { /* private fields */ }
Implementations§
source§impl OpenFlags
impl OpenFlags
sourcepub const RIGHT_READABLE: Self = _
pub const RIGHT_READABLE: Self = _
Can read from target object.
sourcepub const RIGHT_WRITABLE: Self = _
pub const RIGHT_WRITABLE: Self = _
Can write to target object.
sourcepub const RIGHT_EXECUTABLE: Self = _
pub const RIGHT_EXECUTABLE: Self = _
Connection can map target object executable.
sourcepub const CREATE_IF_ABSENT: Self = _
pub const CREATE_IF_ABSENT: Self = _
(with Create) Fail if the object already exists.
sourcepub const DIRECTORY: Self = _
pub const DIRECTORY: Self = _
Assert that the object to be opened is a directory. Return an error if the target object is not a directory.
sourcepub const NODE_REFERENCE: Self = _
pub const NODE_REFERENCE: Self = _
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
, andGetFlags
. The connection will speak theNode
protocol. CallingSetAttr
orSetFlags
will result inZX_ERR_BAD_HANDLE
.
sourcepub const DESCRIBE: Self = _
pub const DESCRIBE: Self = _
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.
sourcepub const POSIX_WRITABLE: Self = _
pub const POSIX_WRITABLE: Self = _
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.
sourcepub const POSIX_EXECUTABLE: Self = _
pub const POSIX_EXECUTABLE: Self = _
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.
sourcepub const NOT_DIRECTORY: Self = _
pub const NOT_DIRECTORY: Self = _
Assert that the object to be opened is not a directory. Return an error if the target object is a directory.
sourcepub const CLONE_SAME_RIGHTS: Self = _
pub const CLONE_SAME_RIGHTS: Self = _
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
.
sourcepub const BLOCK_DEVICE: Self = _
pub const BLOCK_DEVICE: Self = _
Open the target object as a block device.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
.
source§impl OpenFlags
impl OpenFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u32
get_unknown_bits
Trait Implementations§
source§impl BitAndAssign<OpenFlags> for OpenFlags
impl BitAndAssign<OpenFlags> for OpenFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<OpenFlags> for OpenFlags
impl BitOrAssign<OpenFlags> for OpenFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<OpenFlags> for OpenFlags
impl BitXorAssign<OpenFlags> for OpenFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Decode<OpenFlags> for OpenFlags
impl Decode<OpenFlags> for OpenFlags
source§impl Extend<OpenFlags> for OpenFlags
impl Extend<OpenFlags> for OpenFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<OpenFlags> for OpenFlags
impl FromIterator<OpenFlags> for OpenFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for OpenFlags
impl Ord for OpenFlags
source§impl PartialEq<OpenFlags> for OpenFlags
impl PartialEq<OpenFlags> for OpenFlags
source§impl PartialOrd<OpenFlags> for OpenFlags
impl PartialOrd<OpenFlags> for OpenFlags
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<OpenFlags> for OpenFlags
impl SubAssign<OpenFlags> for OpenFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl TypeMarker for OpenFlags
impl TypeMarker for OpenFlags
source§fn inline_align(_context: Context) -> usize
fn inline_align(_context: Context) -> usize
source§fn inline_size(_context: Context) -> usize
fn inline_size(_context: Context) -> usize
inline_align
.§fn encode_is_copy() -> bool
fn encode_is_copy() -> bool
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. Read more§fn decode_is_copy() -> bool
fn decode_is_copy() -> bool
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.