# [−] [src] Struct tokio::time::Interval

    pub struct Interval { /* fields omitted */ }

Stream returned by `interval` and `interval_at`.

## Implementations

### `impl Interval` [src]

#### `pub async fn tick<'_>(&'_ mut self) -> Instant` [src]

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

# Examples

    use tokio::time;

    use std::time::Duration;

    #[tokio::main]
    async fn main() {
        let mut interval = time::interval(Duration::from_millis(10));

        interval.tick().await;
        interval.tick().await;
        interval.tick().await;

        // approximately 20ms have elapsed.
    }

#### `pub fn poll_tick(&mut self, cx: &mut Context<'_>) -> Poll<Instant>` [src]

Poll for the next instant in the interval to be reached.

This method can return the following values:

- `Poll::Pending` if the next instant has not yet been reached.
- `Poll::Ready(instant)` if the next instant has been reached.

When this method returns `Poll::Pending`, the current task is scheduled to receive a wakeup when the instant has elapsed. Note that on multiple calls to `poll_tick`, only the `Waker` from the `Context` passed to the most recent call is scheduled to receive a wakeup.

## Trait Implementations

### `impl Debug for Interval` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `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,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.