Struct fidl_fuchsia_io::NodeProtocolKinds
source · pub struct NodeProtocolKinds { /* private fields */ }
Expand description
A node may have multiple supported representations when opening, even though it may have a fixed underlying identity.
Today, a file is accessed via the [File
] protocol, and sends a
[Representation.FileInfo
] when opened with GET_REPRESENTATION
. However,
in the future we might introduce a more sophisticated FileV2
protocol, or
a more efficient SuperFastFile
backed by a specialized kernel object. New
clients can request the more advanced representations by specifying the
corresponding bits in NodeProtocolKinds
, whereas existing clients would
continue to talk to the node via the old representation.
NodeProtocolKinds
enables forward-compatibility through a form of protocol
negotiation.
The elements have one-to-one correspondence with the members of
Representation
.
Implementations§
source§impl NodeProtocolKinds
impl NodeProtocolKinds
sourcepub const CONNECTOR: Self = _
pub const CONNECTOR: Self = _
The connector representation of a node.
The connection will speak either [Node
] or the target protocol,
depending on the flags used during opening.
sourcepub const DIRECTORY: Self = _
pub const DIRECTORY: Self = _
The directory representation of a node.
The connection will speak the [Directory
] protocol.
sourcepub const FILE: Self = _
pub const FILE: Self = _
The file representation of a node.
The connection will speak the [File
] protocol.
sourcepub const SYMLINK: Self = _
pub const SYMLINK: Self = _
The symlink representation of a node.
The connection will speak the [Symlink
] protocol.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> 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 NodeProtocolKinds
impl NodeProtocolKinds
pub fn from_bits_allow_unknown(bits: u64) -> Self
pub fn has_unknown_bits(&self) -> bool
pub fn get_unknown_bits(&self) -> u64
Trait Implementations§
source§impl Binary for NodeProtocolKinds
impl Binary for NodeProtocolKinds
source§impl BitAnd for NodeProtocolKinds
impl BitAnd for NodeProtocolKinds
source§impl BitAndAssign for NodeProtocolKinds
impl BitAndAssign for NodeProtocolKinds
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for NodeProtocolKinds
impl BitOr for NodeProtocolKinds
source§fn bitor(self, other: NodeProtocolKinds) -> Self
fn bitor(self, other: NodeProtocolKinds) -> Self
Returns the union of the two sets of flags.
§type Output = NodeProtocolKinds
type Output = NodeProtocolKinds
|
operator.source§impl BitOrAssign for NodeProtocolKinds
impl BitOrAssign for NodeProtocolKinds
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for NodeProtocolKinds
impl BitXor for NodeProtocolKinds
source§impl BitXorAssign for NodeProtocolKinds
impl BitXorAssign for NodeProtocolKinds
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for NodeProtocolKinds
impl Clone for NodeProtocolKinds
source§fn clone(&self) -> NodeProtocolKinds
fn clone(&self) -> NodeProtocolKinds
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NodeProtocolKinds
impl Debug for NodeProtocolKinds
source§impl Decode<NodeProtocolKinds> for NodeProtocolKinds
impl Decode<NodeProtocolKinds> for NodeProtocolKinds
source§impl Default for NodeProtocolKinds
impl Default for NodeProtocolKinds
source§fn default() -> NodeProtocolKinds
fn default() -> NodeProtocolKinds
source§impl Encode<NodeProtocolKinds> for NodeProtocolKinds
impl Encode<NodeProtocolKinds> for NodeProtocolKinds
source§impl Extend<NodeProtocolKinds> for NodeProtocolKinds
impl Extend<NodeProtocolKinds> for NodeProtocolKinds
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<NodeProtocolKinds> for NodeProtocolKinds
impl FromIterator<NodeProtocolKinds> for NodeProtocolKinds
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for NodeProtocolKinds
impl Hash for NodeProtocolKinds
source§impl LowerHex for NodeProtocolKinds
impl LowerHex for NodeProtocolKinds
source§impl Not for NodeProtocolKinds
impl Not for NodeProtocolKinds
source§impl Octal for NodeProtocolKinds
impl Octal for NodeProtocolKinds
source§impl Ord for NodeProtocolKinds
impl Ord for NodeProtocolKinds
source§fn cmp(&self, other: &NodeProtocolKinds) -> Ordering
fn cmp(&self, other: &NodeProtocolKinds) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq for NodeProtocolKinds
impl PartialEq for NodeProtocolKinds
source§fn eq(&self, other: &NodeProtocolKinds) -> bool
fn eq(&self, other: &NodeProtocolKinds) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for NodeProtocolKinds
impl PartialOrd for NodeProtocolKinds
source§fn partial_cmp(&self, other: &NodeProtocolKinds) -> Option<Ordering>
fn partial_cmp(&self, other: &NodeProtocolKinds) -> Option<Ordering>
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 Sub for NodeProtocolKinds
impl Sub for NodeProtocolKinds
source§impl SubAssign for NodeProtocolKinds
impl SubAssign for NodeProtocolKinds
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 NodeProtocolKinds
impl TypeMarker for NodeProtocolKinds
§type Owned = NodeProtocolKinds
type Owned = NodeProtocolKinds
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.source§impl UpperHex for NodeProtocolKinds
impl UpperHex for NodeProtocolKinds
source§impl ValueTypeMarker for NodeProtocolKinds
impl ValueTypeMarker for NodeProtocolKinds
§type Borrowed<'a> = NodeProtocolKinds
type Borrowed<'a> = NodeProtocolKinds
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read more