network-time 0.1.1

Abstractions of millisecond durations and timestamps, and related ticks.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

// This file is part of network. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/network/master/COPYRIGHT. No part of network, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2017 The developers of network. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/network/master/COPYRIGHT.


/// Represents a 'tick', currently 128 milliseconds of time.
#[derive(Default, Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
#[derive(Deserialize, Serialize)]
pub struct Tick(u64);

impl Display for Tick
{
	fn fmt(&self, f: &mut Formatter) -> fmt::Result
	{
		write!(f, "{}", self.0)
	}
}

impl Add<u64> for Tick
{
	type Output = Self;
	
	#[inline(always)]
	fn add(self, rhs: u64) -> Self::Output
	{
		Tick(self.0 + rhs)
	}
}

impl AddAssign<u64> for Tick
{
	#[inline(always)]
	fn add_assign(&mut self, other: u64)
	{
		self.0 += other
	}
}

impl Add<TickDuration> for Tick
{
	type Output = Self;
	
	#[inline(always)]
	fn add(self, rhs: TickDuration) -> Self::Output
	{
		Tick(self.0 + rhs.0)
	}
}

impl Sub<u64> for Tick
{
	type Output = Self;
	
	#[inline(always)]
	fn sub(self, rhs: u64) -> Self::Output
	{
		Tick(self.0 - rhs)
	}
}

impl Sub<Tick> for Tick
{
	type Output = TickDuration;
	
	#[inline(always)]
	fn sub(self, rhs: Self) -> Self::Output
	{
		TickDuration(self.0 - rhs.0)
	}
}

impl Div for Tick
{
	type Output = usize;
	
	#[inline(always)]
	fn div(self, rhs: Self) -> Self::Output
	{
		(self.0 / rhs.0) as usize
	}
}

impl Tick
{
	/// Zero.
	pub const Zero: Self = Tick(0);
	
	const MillisecondsPerTick: u64 = 128;
	
	/// Now.
	#[inline(always)]
	pub fn now() -> Self
	{
		Self::milliseconds_to_ticks_rounded_down(MonotonicMillisecondTimestamp::now())
	}
	
	#[doc(hidden)]
	#[inline(always)]
	pub const fn ring_slot_index(self, number_of_ring_slots: usize) -> usize
	{
		(self.0 as usize) % number_of_ring_slots
	}
	
	/// Milliseconds to ticks rounded down.
	#[inline(always)]
	pub fn milliseconds_to_ticks_rounded_down(milliseconds: MonotonicMillisecondTimestamp) -> Tick
	{
		let milliseconds = milliseconds.0;
		Tick(milliseconds / Self::MillisecondsPerTick)
	}
	
	/// Milliseconds to ticks rounded up.
	#[inline(always)]
	pub fn milliseconds_to_ticks_rounded_up(milliseconds: MonotonicMillisecondTimestamp) -> Tick
	{
		let milliseconds = milliseconds.0;
		let ticks_rounded_up = (milliseconds + Self::MillisecondsPerTick - 1) / Self::MillisecondsPerTick;
		Tick(ticks_rounded_up)
	}
	
	/// Ticks to milliseconds.
	#[inline(always)]
	pub fn to_milliseconds(self) -> MonotonicMillisecondTimestamp
	{
		MonotonicMillisecondTimestamp(self.0 * Tick::MillisecondsPerTick)
	}
	
	/// Is zero?
	#[inline(always)]
	pub fn is_zero(self) -> bool
	{
		self.0 == Self::Zero.0
	}
}