Struct FileHandle 

pub struct FileHandle {
    pub handle: Option<NullableHandle>,
    pub flags: Option<FileFlags>,
    pub fd: Option<i32>,
    pub bag: Option<Vec<NullableHandle>>,
    /* private fields */
}

The representation of an open file that can be transferred between the binder device driver and the client.

Fields

handle: Option<NullableHandle>

The handle connecting to the file protocol. If not present, the file should behave as it is was a null file: all read must succeed with empty content and all write must succeed. See fdio_fd_create_null().

flags: Option<FileFlags>

Optional. The flags associated with the opened file.

fd: Option<i32>

Optional. The file descriptor to help with translation between processes.

bag: Option<Vec<NullableHandle>>

Optional. An opaque bag of handles associated with the file.

If this field is set, handle must not be set.

In Fuchsia, there is an expectation that there is a 1:1 mapping between a file descriptor and a handle. In general, we do not want to violate that rule. This field is intended to used in very limited circumstances (compatibility with Linux and Binder), where we need to violate rule.

When this field is used, the composite_fd library will be used to create the file descriptor in a Fuchsia component. Such file descriptors do not support regular operations and must be handled using the composite_fd library.

Trait Implementations

impl Debug for FileHandle

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

Formats the value using the given formatter.

impl Decode<FileHandle, DefaultFuchsiaResourceDialect> for FileHandle

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<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

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

impl Default for FileHandle

fn default() -> FileHandle

Returns the “default value” for a type.

impl Encode<FileHandle, DefaultFuchsiaResourceDialect> for &mut FileHandle

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, 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 FileHandle

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

type Borrowed<'a> = &'a mut FileHandle

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

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

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for FileHandle

type Owned = FileHandle

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 Standalone<DefaultFuchsiaResourceDialect> for FileHandle

impl StructuralPartialEq for FileHandle