Struct fidl_fuchsia_io::NodeOptions

pub struct NodeOptions {
    pub flags: Option<NodeFlags>,
    pub protocols: Option<NodeProtocols>,
    pub mode: Option<CreationMode>,
    pub rights: Option<Operations>,
    pub attributes: Option<NodeAttributesQuery>,
    pub create_attributes: Option<MutableNodeAttributes>,
    /* private fields */
}

DEPRECATED - Use fuchsia.io/Flags + fuchsia.io/Options instead.

Fields

flags: Option<NodeFlags>

protocols: Option<NodeProtocols>

Callers may assert the type of the object by setting the protocol corresponding to the expected type:

• If the caller expected a directory but the node cannot be accessed as a directory, the error is ZX_ERR_NOT_DIR.

• If the caller expected a file but the node cannot be accessed as a file, the error is ZX_ERR_NOT_FILE.

• In other mismatched cases, and for an empty table, the error is ZX_ERR_WRONG_TYPE.

If more than one protocol is present, the resultant protocol may become any one of them. Callers should specify [NodeFlags.GET_REPRESENTATION] to receive a [Node.OnRepresentation] event, in order to ascertain the protocol.

If absent, indicates that the caller accepts any [Node] protocol (including [Node] itself for connector nodes, for instance).

mode: Option<CreationMode>

Specifies how the target object should be created. If an object is to be created, its type must be specified by protocols. The check for existence and creation of the new object are performed atomically.

If the type is ambiguous (e.g. both directory and file are set), the request must fail with ZX_ERR_INVALID_ARGS.

rights: Option<Operations>

Requested rights on the new connection. If any [rights] exceed those of the current connection, [object_request] will be closed with ZX_ERR_ACCESS_DENIED.

The rights granted to the connection will be downscoped to those operations the target node type supports. For example, if the target node is a file and both [Rights.WRITE_BYTES] and [Rights.MODIFY_DIRECTORY] are requested, the resulting connection will only be granted [Rights.WRITE_BYTES].

If the rights field is absent, it is the equivalent of empty rights.

attributes: Option<NodeAttributesQuery>

If the [NodeFlags.GET_REPRESENTATION] flag is set, attributes to be returned in [Node.OnRepresentation]. This requires the [Rights.GET_ATTRIBUTES] right on the parent connection, but not the resulting connection.

create_attributes: Option<MutableNodeAttributes>

If an object is to be created, this specifies attributes that should be stored with the object at creation time. This requires the [Rights.UPDATE_ATTRIBUTES] right on the parent connection, but not the resulting connection. Requests will fail with ZX_ERR_NOT_SUPPORTED if any specified attributes are not supported.

Trait Implementations

impl Clone for NodeOptions

fn clone(&self) -> NodeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeOptions

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<NodeOptions, D> for NodeOptions

fn new_empty() -> Self

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

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

impl Default for NodeOptions

fn default() -> NodeOptions

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<NodeOptions, D> for &NodeOptions

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

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

impl PartialEq for NodeOptions

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

type Owned = NodeOptions

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 ValueTypeMarker for NodeOptions

type Borrowed<'a> = &'a NodeOptions

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

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

impl Persistable for NodeOptions

impl StructuralPartialEq for NodeOptions