mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-04 19:12:50 +00:00
Rollup merge of #88465 - marcospb19:master, r=joshtriplett
Adding examples to docs of `std::time` module And adding missing link to `Duration` from `Instant`.
This commit is contained in:
commit
497267a961
@ -2,14 +2,21 @@
|
||||
|
||||
//! Temporal quantification.
|
||||
//!
|
||||
//! Example:
|
||||
//! # Examples:
|
||||
//!
|
||||
//! There are multiple ways to create a new [`Duration`]:
|
||||
//!
|
||||
//! ```
|
||||
//! use std::time::Duration;
|
||||
//! # use std::time::Duration;
|
||||
//! let five_seconds = Duration::from_secs(5);
|
||||
//! assert_eq!(five_seconds, Duration::from_millis(5_000));
|
||||
//! assert_eq!(five_seconds, Duration::from_micros(5_000_000));
|
||||
//! assert_eq!(five_seconds, Duration::from_nanos(5_000_000_000));
|
||||
//!
|
||||
//! let five_seconds = Duration::new(5, 0);
|
||||
//! // both declarations are equivalent
|
||||
//! assert_eq!(Duration::new(5, 0), Duration::from_secs(5));
|
||||
//! let ten_seconds = Duration::from_secs(10);
|
||||
//! let seven_nanos = Duration::from_nanos(7);
|
||||
//! let total = ten_seconds + seven_nanos;
|
||||
//! assert_eq!(total, Duration::new(10, 7));
|
||||
//! ```
|
||||
|
||||
use crate::fmt;
|
||||
|
@ -1,13 +1,32 @@
|
||||
//! Temporal quantification.
|
||||
//!
|
||||
//! Example:
|
||||
//! # Examples:
|
||||
//!
|
||||
//! There are multiple ways to create a new [`Duration`]:
|
||||
//!
|
||||
//! ```
|
||||
//! use std::time::Duration;
|
||||
//! # use std::time::Duration;
|
||||
//! let five_seconds = Duration::from_secs(5);
|
||||
//! assert_eq!(five_seconds, Duration::from_millis(5_000));
|
||||
//! assert_eq!(five_seconds, Duration::from_micros(5_000_000));
|
||||
//! assert_eq!(five_seconds, Duration::from_nanos(5_000_000_000));
|
||||
//!
|
||||
//! let five_seconds = Duration::new(5, 0);
|
||||
//! // both declarations are equivalent
|
||||
//! assert_eq!(Duration::new(5, 0), Duration::from_secs(5));
|
||||
//! let ten_seconds = Duration::from_secs(10);
|
||||
//! let seven_nanos = Duration::from_nanos(7);
|
||||
//! let total = ten_seconds + seven_nanos;
|
||||
//! assert_eq!(total, Duration::new(10, 7));
|
||||
//! ```
|
||||
//!
|
||||
//! Using [`Instant`] to calculate how long a function took to run:
|
||||
//!
|
||||
//! ```ignore (incomplete)
|
||||
//! let now = Instant::now();
|
||||
//!
|
||||
//! // Calling a slow function, it may take a while
|
||||
//! slow_function();
|
||||
//!
|
||||
//! let elapsed_time = now.elapsed();
|
||||
//! println!("Running slow_function() took {} seconds.", elapsed_time.as_secs());
|
||||
//! ```
|
||||
|
||||
#![stable(feature = "time", since = "1.3.0")]
|
||||
@ -26,7 +45,7 @@ use crate::sys_common::FromInner;
|
||||
pub use core::time::Duration;
|
||||
|
||||
/// A measurement of a monotonically nondecreasing clock.
|
||||
/// Opaque and useful only with `Duration`.
|
||||
/// Opaque and useful only with [`Duration`].
|
||||
///
|
||||
/// Instants are always guaranteed to be no less than any previously measured
|
||||
/// instant when created, and are often useful for tasks such as measuring
|
||||
|
Loading…
Reference in New Issue
Block a user