network-time 0.1.1

// 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.


/// A tick duration; relative time.
#[derive(Default, Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
#[derive(Deserialize, Serialize)]
pub struct TickDuration(u64);

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

impl Mul<u64> for TickDuration
{
	type Output = Self;
	
	#[inline(always)]
	fn mul(self, rhs: u64) -> Self::Output
	{
		TickDuration(self.0 * rhs)
	}
}

impl From<u64> for TickDuration
{
	#[inline(always)]
	fn from(value: u64) -> Self
	{
		Self::new(value)
	}
}

impl Into<u64> for TickDuration
{
	#[inline(always)]
	fn into(self) -> u64
	{
		self.0
	}
}

impl TickDuration
{
	/// Zero.
	pub const Zero: Self = TickDuration(0);
	
	/// New instance.
	#[inline(always)]
	pub const fn new(ticks: u64) -> Self
	{
		TickDuration(ticks)
	}
	
	/// Milliseconds to ticks rounded down.
	#[inline(always)]
	pub fn milliseconds_to_ticks_rounded_down(milliseconds: MillisecondDuration) -> Self
	{
		let milliseconds: u64 = milliseconds.into();
		TickDuration(milliseconds / Tick::MillisecondsPerTick)
	}
	
	/// Milliseconds to ticks rounded up.
	#[inline(always)]
	pub fn milliseconds_to_ticks_rounded_up(milliseconds: MillisecondDuration) -> Self
	{
		let milliseconds: u64 = milliseconds.into();
		let ticks_rounded_up = (milliseconds + Tick::MillisecondsPerTick - 1) / Tick::MillisecondsPerTick;
		TickDuration(ticks_rounded_up)
	}
	
	/// Is zero?
	#[inline(always)]
	pub fn is_zero(self) -> bool
	{
		self.0 == Self::Zero.0
	}
}