Interval

rune_modules::time

Struct Interval

pub struct Interval { /* private fields */ }

Expand description

Interval returned by [interval] and [interval_at].

This type allows you to wait on a sequence of instants with a certain duration between each instant. Unlike calling [sleep] in a loop, this lets you count the time spent between the calls to [sleep] as well.

Implementations§

impl Interval

pub async fn tick(internal: Mut<Interval>)

Completes when the next instant in the interval has been reached.

§Cancel safety

This method is cancellation safe. If tick is used as the branch in a select and another branch completes first, then no tick has been consumed.

§Examples

use time::Duration;

let  interval = time::interval(Duration::from_millis(10));

interval.tick().await;
println!("approximately 0ms have elapsed. The first tick completes immediately.");
interval.tick().await;
interval.tick().await;

println!("approximately 20ms have elapsed...");

Trait Implementations§

impl Any for Interval

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

impl Debug for Interval

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

Formats the value using the given formatter. Read more

impl InstallWith for Interval

fn install_with(module: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

impl MaybeTypeOf for Interval

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for Interval

const ITEM: &'static Item

The name item.

fn full_name(f: &mut Formatter<'_>) -> Result

The full name of the type.

fn display() -> impl Display

Return a display wrapper for the full name of the type.

impl TypeHash for Interval

const HASH: Hash

The complete type hash of the type including type parameters which uniquely identifiers a given type. Read more

impl TypeOf for Interval

const PARAMETERS: Hash

Type parameters for the type. Read more

const STATIC_TYPE_INFO: AnyTypeInfo = <Self as rune::Any>::ANY_TYPE_INFO

Access diagnostical type information for the current type. Read more

fn type_info() -> TypeInfo

Get type info associated with the current type.

impl UnsafeToMut for Interval

type Guard = RawValueGuard

The raw guard returned. Read more

unsafe fn unsafe_to_mut<'a>( value: Value, ) -> Result<(&'a mut Self, Self::Guard), RuntimeError>

Safety Read more

impl UnsafeToRef for Interval

type Guard = RawValueGuard

The raw guard returned. Read more

unsafe fn unsafe_to_ref<'a>( value: Value, ) -> Result<(&'a Self, Self::Guard), RuntimeError>

Safety Read more

impl UnsafeToValue for &Interval

type Guard = ValueRefGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value. Read more

impl UnsafeToValue for &mut Interval

type Guard = ValueMutGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value. Read more

impl AnyMarker for Interval

Auto Trait Implementations§

impl Freeze for Interval

impl !RefUnwindSafe for Interval

impl Send for Interval

impl Sync for Interval

impl Unpin for Interval

impl !UnwindSafe for Interval

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromValue for T
where T: AnyMarker,

fn from_value(value: Value) -> Result<T, RuntimeError>

Try to convert to the given type, from the given value.

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

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

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

impl<T> ToReturn for T
where T: ToValue,

fn to_return(self) -> VmResult<Value>

Convert something into a return value.

impl<T> ToValue for T
where T: AnyMarker,

fn to_value(self) -> Result<Value, RuntimeError>

Convert into a value.

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnsafeToValue for T
where T: ToValue,

type Guard = ()

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value( self, ) -> Result<(Value, <T as UnsafeToValue>::Guard), RuntimeError>

Convert into a value. Read more

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

impl<T> ErasedDestructor for T
where T: 'static,