Struct fidl_fuchsia_io::FileInfo

pub struct FileInfo {
    pub is_append: Option<bool>,
    pub observer: Option<Event>,
    pub stream: Option<Stream>,
    pub attributes: Option<NodeAttributes2>,
    /* private fields */
}

Auxiliary data for the file representation of a node.

Fields

is_append: Option<bool>

True if the file is opened in append mode. In append mode, the seek offset is moved to the end before every write, the two steps performed in an atomic manner.

observer: Option<Event>

An optional event which transmits information about an object’s readability or writability. This event relays information about the underlying object, not the capability granted to client: this event may be signalled “readable” on a connection that does not have the capability to read.

This event will be present if the following conditions are met:

• The available_operations on the file connection is not empty.
• The filesystem supports signalling readability/writability events.

The FileSignal values may be observed on this event.

stream: Option<Stream>

An optional stream object, which can be used to read to and write from the file.

Reading and writing the file using the stream object can be up to 20x faster than reading and writing the file using the Read and Write operations in the [File] protocol.

attributes: Option<NodeAttributes2>

Requested attributes for the file. This is only populated if requested.

Trait Implementations

impl Debug for FileInfo

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

Formats the value using the given formatter.

impl Decode<FileInfo, DefaultFuchsiaResourceDialect> for FileInfo

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 FileInfo

fn default() -> FileInfo

Returns the “default value” for a type.

impl Encode<FileInfo, DefaultFuchsiaResourceDialect> for &mut FileInfo

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 FileInfo

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

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

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 FileInfo

type Owned = FileInfo

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 FileInfo

impl StructuralPartialEq for FileInfo