Simulator

Struct Simulator 

Source
pub struct Simulator<'a, Message, Theme = Theme, Renderer = Renderer> { /* private fields */ }
Expand description

A user interface that can be interacted with and inspected programmatically.

Implementations§

Source§

impl<'a, Message, Theme, Renderer> Simulator<'a, Message, Theme, Renderer>
where Theme: Base, Renderer: Renderer + Headless,

Source

pub fn new(element: impl Into<Element<'a, Message, Theme, Renderer>>) -> Self

Creates a new Simulator with default [Settings] and a default size (1024x768).

Source

pub fn with_settings( settings: Settings, element: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Self

Creates a new Simulator with the given [Settings] and a default size (1024x768).

Source

pub fn with_size( settings: Settings, size: impl Into<Size>, element: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Self

Creates a new Simulator with the given [Settings] and size.

Source

pub fn find<S>(&mut self, selector: S) -> Result<S::Output, Error>
where S: Selector + Send, S::Output: Clone + Send,

Finds the target of the given widget Selector in the Simulator.

Source

pub fn point_at(&mut self, position: impl Into<Point>)

Points the mouse cursor at the given position in the Simulator.

This does not produce mouse movement events!

Source

pub fn click<S>(&mut self, selector: S) -> Result<S::Output, Error>
where S: Selector + Send, S::Output: Bounded + Clone + Send + Sync + 'static,

Clicks the [Bounded] target found by the given Selector, if any.

This consists in:

  • Pointing the mouse cursor at the center of the [Bounded] target.
  • Simulating a click.
Source

pub fn tap_key(&mut self, key: impl Into<Key>) -> Status

Simulates a key press, followed by a release, in the Simulator.

Source

pub fn typewrite(&mut self, text: &str) -> Status

Simulates a user typing in the keyboard the given text in the Simulator.

Source

pub fn simulate( &mut self, events: impl IntoIterator<Item = Event>, ) -> Vec<Status>

Simulates the given raw sequence of events in the Simulator.

Source

pub fn snapshot(&mut self, theme: &Theme) -> Result<Snapshot, Error>

Draws and takes a Snapshot of the interface in the Simulator.

Source

pub fn into_messages( self, ) -> impl Iterator<Item = Message> + use<Message, Theme, Renderer>

Turns the Simulator into the sequence of messages produced by any interactions.

Auto Trait Implementations§

§

impl<'a, Message, Theme, Renderer> Freeze for Simulator<'a, Message, Theme, Renderer>
where Renderer: Freeze,

§

impl<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !RefUnwindSafe for Simulator<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Send for Simulator<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Sync for Simulator<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme, Renderer> Unpin for Simulator<'a, Message, Theme, Renderer>
where Renderer: Unpin, Message: Unpin,

§

impl<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !UnwindSafe for Simulator<'a, Message, Theme, Renderer>

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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

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.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

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

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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