Skip to main content

ComposeTestRule

Struct ComposeTestRule 

Source
pub struct ComposeTestRule { /* private fields */ }
Expand description

Headless harness for exercising compositions in tests.

ComposeTestRule mirrors the ergonomics of the Jetpack Compose testing APIs while remaining lightweight and allocation-friendly for unit tests. It owns an in-memory applier and exposes helpers for driving recomposition and draining frame callbacks without requiring a windowing backend.

Implementations§

Source§

impl ComposeTestRule

Source

pub fn new() -> Self

Create a new test rule backed by the default in-memory applier.

Source

pub fn set_content( &mut self, content: impl FnMut() + 'static, ) -> Result<(), NodeError>

Install the provided content into the composition and perform an initial render.

Source

pub fn recomposition(&mut self) -> Result<(), NodeError>

Force a recomposition using the currently installed content.

Source

pub fn advance_frame(&mut self, frame_time_nanos: u64) -> Result<(), NodeError>

Drain scheduled frame callbacks at the supplied timestamp and process any resulting work until the composition becomes idle.

Source

pub fn pump_until_idle(&mut self) -> Result<(), NodeError>

Drive the composition until there are no pending renders, invalidated scopes, or enqueued node mutations remaining.

Source

pub fn runtime_handle(&self) -> RuntimeHandle

Access the runtime driving this rule. Useful for constructing shared state objects within the composition.

Source

pub fn applier_mut(&mut self) -> ApplierGuard<'_, MemoryApplier>

Gain mutable access to the underlying in-memory applier for assertions about the produced node tree.

Source

pub fn dump_tree(&mut self) -> String

Dump the current node tree as text for debugging

Source

pub fn has_content(&self) -> bool

Returns whether user content has been installed in this rule.

Source

pub fn root_id(&self) -> Option<NodeId>

Returns the id of the root node produced by the current composition.

Source

pub fn composition(&mut self) -> &mut Composition<MemoryApplier>

Gain mutable access to the raw composition for advanced scenarios.

Trait Implementations§

Source§

impl Default for ComposeTestRule

Source§

fn default() -> Self

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

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
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
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

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>,

Source§

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

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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