Struct ViewIdentityOnCreation

pub struct ViewIdentityOnCreation {
    pub view_ref: ViewRef,
    pub view_ref_control: ViewRefControl,
}

Convenience data type to self-identify the view, during view creation.

A ViewRef is used to identify the view, and can be freely cloned and distributed to other components.

A ViewRefControl is used to implement lifecycle notification, and must not be cloned, and cannot be distributed to other components. Scenic binds the ViewRefControl object to the view, so when the view is destroyed, the destruction of the ViewRefControl triggers a ZX_EVENTPAIR_PEER_CLOSED signal to all ViewRef holders, thus notifying view death.

Usage: When creating a view, place a ViewRef and ViewRefControl together in this struct, so that they travel as a unit to the destination component. This convenience struct allows a protocol author to describe this traveling pair as one argument. It improves readability and reduces mishandling.

Fields

view_ref: ViewRef

Stable identifier for the view to be created.

view_ref_control: ViewRefControl

A mechanism for lifecycle notification.

Trait Implementations

impl Debug for ViewIdentityOnCreation

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

Formats the value using the given formatter.

impl Decode<ViewIdentityOnCreation, DefaultFuchsiaResourceDialect> for ViewIdentityOnCreation

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 Encode<ViewIdentityOnCreation, DefaultFuchsiaResourceDialect> for &mut ViewIdentityOnCreation

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<T0: Encode<ViewRef, DefaultFuchsiaResourceDialect>, T1: Encode<ViewRefControl, DefaultFuchsiaResourceDialect>> Encode<ViewIdentityOnCreation, DefaultFuchsiaResourceDialect> for (T0, T1)

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 Hash for ViewIdentityOnCreation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ViewIdentityOnCreation

fn cmp(&self, other: &ViewIdentityOnCreation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ViewIdentityOnCreation

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

fn partial_cmp(&self, other: &ViewIdentityOnCreation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ResourceTypeMarker for ViewIdentityOnCreation

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

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 ViewIdentityOnCreation

type Owned = ViewIdentityOnCreation

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 Eq for ViewIdentityOnCreation

impl Standalone<DefaultFuchsiaResourceDialect> for ViewIdentityOnCreation

impl StructuralPartialEq for ViewIdentityOnCreation