Struct Zoned 

pub struct Zoned<C: Clock> { /* private fields */ }

A wrapper that adds timezone support to any clock.

Zoned<C> wraps any clock implementing Clock and adds timezone functionality by implementing ZonedClock. It can convert UTC time to local time in the specified timezone.

Deref Behavior

This type implements Deref to allow direct access to the wrapped clock’s methods. This is particularly useful when wrapping controllable clocks like MockClock.

Trait Forwarding

When the wrapped clock implements NanoClock or ControllableClock, Zoned<C> implements the same trait and delegates calls to the wrapped clock. This lets Zoned<MockClock> be used as dyn ControllableClock and Zoned<NanoMonotonicClock> be used as dyn NanoClock.

Examples

use qubit_clock::{Clock, ZonedClock, SystemClock, Zoned};
use chrono_tz::Asia::Shanghai;

// Wrap a SystemClock with Shanghai timezone
let clock = Zoned::new(SystemClock::new(), Shanghai);
let local = clock.local_time();
println!("Local time in Shanghai: {}", local);

Using with MockClock

use qubit_clock::{
    Clock, ZonedClock, ControllableClock, MockClock, Zoned
};
use chrono::{DateTime, Utc};
use chrono_tz::Asia::Shanghai;

let mock = MockClock::new();
let clock = Zoned::new(mock, Shanghai);

// Can use ZonedClock methods
let local = clock.local_time();

// Can also use ControllableClock methods via Deref
let time = DateTime::parse_from_rfc3339(
    "2024-01-01T00:00:00Z"
).unwrap().with_timezone(&Utc);
clock.set_time(time);

Implementations

impl<C: Clock> Zoned<C>

pub fn new(clock: C, timezone: Tz) -> Self

Creates a new Zoned clock wrapping the given clock with the specified timezone.

Arguments

• clock - The clock to wrap.
• timezone - The timezone to use for local time conversions.

Returns

A new Zoned<C> instance.

Examples

use qubit_clock::{SystemClock, Zoned};
use chrono_tz::Asia::Shanghai;

let clock = Zoned::new(SystemClock::new(), Shanghai);

pub fn inner(&self) -> &C

Returns a reference to the inner clock.

Returns

A reference to the wrapped clock.

Examples

use qubit_clock::{Clock, SystemClock, Zoned};
use chrono_tz::Asia::Shanghai;

let clock = Zoned::new(SystemClock::new(), Shanghai);
let inner = clock.inner();
let millis = inner.millis();

pub fn into_inner(self) -> C

Consumes the Zoned wrapper and returns the inner clock.

Returns

The wrapped clock.

Examples

use qubit_clock::{SystemClock, Zoned};
use chrono_tz::Asia::Shanghai;

let clock = Zoned::new(SystemClock::new(), Shanghai);
let inner = clock.into_inner();

Trait Implementations

impl<C: Clock> Clock for Zoned<C>

fn millis(&self) -> i64

Returns the current time as a Unix timestamp in milliseconds (UTC).

fn time(&self) -> DateTime<Utc>

Returns the current time as a DateTime<Utc>.

impl<C: Clone + Clock> Clone for Zoned<C>

fn clone(&self) -> Zoned<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: ControllableClock> ControllableClock for Zoned<C>

fn set_time(&self, instant: DateTime<Utc>)

Sets or aligns the clock to a specific time.

fn add_duration(&self, duration: Duration)

Advances the clock by the specified duration.

fn reset(&self)

Resets the clock to its initial state.

impl<C: Debug + Clock> Debug for Zoned<C>

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

Formats the value using the given formatter.

impl<C: Clock> Deref for Zoned<C>

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<C: NanoClock> NanoClock for Zoned<C>

fn nanos(&self) -> i128

Returns the current time as a Unix timestamp in nanoseconds (UTC).

fn time_precise(&self) -> DateTime<Utc>

Returns the current time as a DateTime<Utc> with nanosecond precision.

impl<C: Clock> ZonedClock for Zoned<C>

fn timezone(&self) -> Tz

Returns the timezone of this clock.

fn local_time(&self) -> DateTime<Tz>

Returns the current local time in this clock’s timezone.