Struct vmcore::vmtime::VmTimeAccess

pub struct VmTimeAccess { /* private fields */ }

An individual time accessor, used to query and wait for time.

Implementations

impl VmTimeAccess

pub fn now(&self) -> VmTime

Gets the current time.

pub fn host_time(&self, time: VmTime) -> Option<Instant>

Returns the host time corresponding to a guest time.

If the guest time is before the VM last resumed, then returns the time the VM last resumed.

If the VM is not running, returns None.

pub fn get_timeout(&self) -> Option<VmTime>

Get the currently set timeout.

pub fn set_timeout(&mut self, time: VmTime)

Sets the timeout poll_timeout will return ready.

pub fn set_timeout_if_before(&mut self, time: VmTime)

Sets the timeout for poll_timeout will return ready, but only if time is earlier than the current timeout.

pub fn cancel_timeout(&mut self)

Clears the current timeout for poll_timeout.

pub fn poll_timeout(&mut self, cx: &mut Context<'_>) -> Poll<VmTime>

Polls the current time against the current timeout.

Returns Poll::Ready(self.now()) if the current timeout is before now. Returns Poll::Pending if there is no current timeout, or if the current timeout is after now.

Although this takes &self, note that it only stores a single waker, meaning that if you poll this from multiple tasks concurrently, only one task will be woken when the time elapses. Create another instance of this type with VmTimeSource if you need to poll this from multiple tasks.

Trait Implementations

impl Drop for VmTimeAccess

fn drop(&mut self)

Executes the destructor for this type.

impl Inspect for VmTimeAccess

fn inspect(&self, req: Request<'_>)

Inspects the object.