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 */
}
Expand description

Options used when opening a node.

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 [rights] exceed the rights of the requesting connection then [object_request] will be closed with a ZX_ERR_ACCESS_DENIED epitaph.

This applies in addition to [DirectoryProtocolOptions.optional_rights].

If absent, inherits appropriate rights from the requesting connection. For example, if using the node protocol, only the GET_ATTRIBUTES right is inherited.

§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 this is not required on 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. Servers might not support setting any or all attributes in which case they will return ZX_ERR_NOT_SUPPORTED.

Trait Implementations§

source§

impl Clone for NodeOptions

source§

fn clone(&self) -> NodeOptions

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NodeOptions

source§

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

Formats the value using the given formatter. Read more
source§

impl Decode<NodeOptions> for NodeOptions

source§

fn new_empty() -> Self

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

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

Decodes an object of type T from the decoder’s buffers into self. Read more
source§

impl Default for NodeOptions

source§

fn default() -> NodeOptions

Returns the “default value” for a type. Read more
source§

impl Encode<NodeOptions> for &NodeOptions

source§

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

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

impl PartialEq for NodeOptions

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl TypeMarker for NodeOptions

§

type Owned = NodeOptions

The owned Rust type which this FIDL type decodes into.
source§

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.
source§

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. Read more
§

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.
source§

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: Read more
source§

fn borrow<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

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

impl Persistable for NodeOptions

source§

impl StructuralPartialEq for NodeOptions

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Body for T
where T: Persistable,

§

type MarkerAtTopLevel = T

The marker type to use when the body is at the top-level.
§

type MarkerInResultUnion = T

The marker type to use when the body is nested in a result union.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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. Read more
§

impl<E> ErrorType for E
where E: ValueTypeMarker<Owned = E> + Decode<E>,

§

type Marker = E

The marker type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more