Struct FakeClockProxy

pub struct FakeClockProxy { /* private fields */ }

Implementations

impl FakeClockProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.testing/FakeClock.

pub fn take_event_stream(&self) -> FakeClockEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get( &self, ) -> QueryResponseFut<(BootInstant, MonotonicInstant), DefaultFuchsiaResourceDialect>

Gets the current time.

pub fn register_event_in_monotonic( &self, event: EventPair, time: MonotonicInstant, ) -> Result<(), Error>

Registers the event handle event to be signaled with ZX_EVENTPAIR_SIGNALED when the provided time is reached by the fake monotonic clock. The FakeClock instance will retain this event (even after it’s fired) for as long as the client-side of the provided event pair event is open.

pub fn register_event_in_boot( &self, event: EventPair, time: BootInstant, ) -> Result<(), Error>

Registers the event handle event to be signaled with ZX_EVENTPAIR_SIGNALED when the provided time is reached by the fake boot clock. The FakeClock instance will retain this event (even after it’s fired) for as long as the client-side of the provided event pair event is open.

pub fn reschedule_event_in_monotonic( &self, event: EventPair, time: MonotonicInstant, ) -> QueryResponseFut<FakeClockRescheduleEventInMonotonicResult, DefaultFuchsiaResourceDialect>

Reschedules an event to be signalled with ZX_EVENTPAIR_SIGNALED at the new deadline in time on the monotonic clock. event is a duplicate of the client-side of the event pair, and it’s used to retrieve the originally registered event through its kernel object identifier.

pub fn reschedule_event_in_boot( &self, event: EventPair, time: BootInstant, ) -> QueryResponseFut<FakeClockRescheduleEventInBootResult, DefaultFuchsiaResourceDialect>

Reschedules an event to be signalled with ZX_EVENTPAIR_SIGNALED at the new deadline in time on the boot clock. event is a duplicate of the client-side of the event pair, and it’s used to retrieve the originally registered event through its kernel object identifier.

pub fn cancel_event( &self, event: EventPair, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Cancels a previously registered event. event is a duplicate of the client-side of the event pair, and it’s used to retrieve the originally registered event through its kernel object identifier.

pub fn create_named_deadline_in_monotonic( &self, id: &DeadlineId, duration: i64, ) -> QueryResponseFut<MonotonicInstant, DefaultFuchsiaResourceDialect>

Calculate and set a deadline associated with an id on the monotonic clock. The returned deadline is calculated as duration after the current fake time. FakeClock emits two events: A SET event immediately, and an EXPIRED event when the deadline expires. A test using FakeClockControl may reference events related to the deadline using a matching id. See FakeClockControl.SetStopPoint for information on how a test can wait for a deadline event.

pub fn create_named_deadline_in_boot( &self, id: &DeadlineId, duration: i64, ) -> QueryResponseFut<BootInstant, DefaultFuchsiaResourceDialect>

Calculate and set a deadline associated with an id on the boot clock. The returned deadline is calculated as duration after the current fake time. FakeClock emits two events: A SET event immediately, and an EXPIRED event when the deadline expires. A test using FakeClockControl may reference events related to the deadline using a matching id. See FakeClockControl.SetStopPoint for information on how a test can wait for a deadline event.

Trait Implementations

impl Clone for FakeClockProxy

fn clone(&self) -> FakeClockProxy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FakeClockProxy

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

Formats the value using the given formatter.

impl FakeClockProxyInterface for FakeClockProxy

type GetResponseFut = QueryResponseFut<(Instant<BootTimeline>, Instant<MonotonicTimeline>)>

type RescheduleEventInMonotonicResponseFut = QueryResponseFut<Result<(), i32>>

type RescheduleEventInBootResponseFut = QueryResponseFut<Result<(), i32>>

type CancelEventResponseFut = QueryResponseFut<()>

type CreateNamedDeadlineInMonotonicResponseFut = QueryResponseFut<Instant<MonotonicTimeline>>

type CreateNamedDeadlineInBootResponseFut = QueryResponseFut<Instant<BootTimeline>>

fn get(&self) -> Self::GetResponseFut

fn register_event_in_monotonic( &self, event: EventPair, time: MonotonicInstant, ) -> Result<(), Error>

fn register_event_in_boot( &self, event: EventPair, time: BootInstant, ) -> Result<(), Error>

fn reschedule_event_in_monotonic( &self, event: EventPair, time: MonotonicInstant, ) -> Self::RescheduleEventInMonotonicResponseFut

fn reschedule_event_in_boot( &self, event: EventPair, time: BootInstant, ) -> Self::RescheduleEventInBootResponseFut

fn cancel_event(&self, event: EventPair) -> Self::CancelEventResponseFut

fn create_named_deadline_in_monotonic( &self, id: &DeadlineId, duration: i64, ) -> Self::CreateNamedDeadlineInMonotonicResponseFut

fn create_named_deadline_in_boot( &self, id: &DeadlineId, duration: i64, ) -> Self::CreateNamedDeadlineInBootResponseFut

impl Proxy for FakeClockProxy

type Protocol = FakeClockMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.