Struct Timestamp 

pub struct Timestamp { /* private fields */ }

Timestamp of a metric entry

This type should with #[metrics(timestamp)] attribute on the root of your metrics entry. Unless otherwise specified, it will record the time that it was created at. If you need to record a different time, use Timestamp::new.

When used as a field (without the #[metrics(timestamp)] attribute), Timestamp will record a value field (not a metric) containing the current timestamp. By default, Timestamp will report units of Millisecond. You can control the unit with the unit attribute.

Implementations

impl Timestamp

pub fn now() -> Self

Create a new timestamp at the current time.

The time will be loaded from metrique_timesource::time_source

This is the behavior of Timestamp::default

pub fn new(time: SystemTime) -> Self

Create a new timestamp at a specific time

pub fn new_from_time_source(ts: TimeSource) -> Self

Create a new timestamp at a specific time from an explicit TimeSource

Examples

use std::time::UNIX_EPOCH;
use metrique_timesource::{TimeSource, fakes::StaticTimeSource};
use metrique::timers::Timestamp;
let ts = TimeSource::custom(StaticTimeSource::at_time(UNIX_EPOCH));
let timestamp = Timestamp::new_from_time_source(ts);

Trait Implementations

impl CloseValue for &Timestamp

type Closed = TimestampValue

The type produced by closing this value

fn close(self) -> Self::Closed

Close the value

impl CloseValue for Timestamp

type Closed = TimestampValue

The type produced by closing this value

fn close(self) -> Self::Closed

Close the value

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Default for Timestamp

fn default() -> Self

Returns the “default value” for a type.