Enum fidl_fuchsia_test_manager::SuiteEventPayload

pub enum SuiteEventPayload {
    CaseFound(CaseFound),
    CaseStarted(CaseStarted),
    CaseStopped(CaseStopped),
    CaseFinished(CaseFinished),
    CaseArtifact(CaseArtifact),
    SuiteArtifact(SuiteArtifact),
    SuiteStarted(SuiteStarted),
    SuiteStopped(SuiteStopped),
    // some variants omitted
}

Various events for test execution.

First event for a test case will always be case_found and last will be case_finished. Events case_started and case_artifact can come in any order. There can be some case_artifact between case_stopped and case_finished. suite_stopped event will always fire when the whole suite has finished executing. Note suite_artifact may fire at any time. In the case where the client completely drains all events for a suite, case_stopped and case_finished will be reported for all found test cases, even if the test component fails to report a result. In the case a test is hung, GetEvents will hang and not complete, unless a timeout has been specified in RunOptions.

Variants

CaseFound(CaseFound)

A case was found.

CaseStarted(CaseStarted)

A case started execution

CaseStopped(CaseStopped)

A case stopped executing, includes the pass/fail/skipped result of the case. The client might still get artifacts pertaining to this test after this event.

CaseFinished(CaseFinished)

A case has finished and all artifact events have been dispatched to the client.

CaseArtifact(CaseArtifact)

Artifact from a case

SuiteArtifact(SuiteArtifact)

Artifact from a suite.

SuiteStarted(SuiteStarted)

Suite started execution

SuiteStopped(SuiteStopped)

Suite run stopped executing, includes the result of the suite. The client might still get artifacts pertaining to this suite after this event.

Implementations

impl SuiteEventPayload

pub fn ordinal(&self) -> u64

pub fn unknown_variant_for_testing() -> Self

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Debug for SuiteEventPayload

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

Formats the value using the given formatter.

impl Decode<SuiteEventPayload> for SuiteEventPayload

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

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

impl Encode<SuiteEventPayload> for &mut SuiteEventPayload

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.

impl PartialEq for SuiteEventPayload

fn eq(&self, other: &Self) -> 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 SuiteEventPayload

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

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 SuiteEventPayload

type Owned = SuiteEventPayload

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 for SuiteEventPayload