Skip to content

Commit 7ac49c8

Browse files
mickvandijkeda2ce7
mickvandijke
authored and
da2ce7
committed
refactor: renamed SinceUnixEpoch to DurationSinceUnixEpoch to be more descriptive
1 parent 5870954 commit 7ac49c8

File tree

5 files changed

+29
-29
lines changed

5 files changed

+29
-29
lines changed

‎src/databases/sqlite.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use r2d2_sqlite::SqliteConnectionManager;
77

88
use crate::databases::database;
99
use crate::databases::database::{Database, Error};
10-
use crate::protocol::clock::clock::SinceUnixEpoch;
10+
use crate::protocol::clock::clock::DurationSinceUnixEpoch;
1111
use crate::tracker::key::AuthKey;
1212
use crate::InfoHash;
1313

@@ -86,7 +86,7 @@ impl Database for SqliteDatabase {
8686

8787
Ok(AuthKey {
8888
key,
89-
valid_until: Some(SinceUnixEpoch::from_secs(valid_until as u64)),
89+
valid_until: Some(DurationSinceUnixEpoch::from_secs(valid_until as u64)),
9090
})
9191
})?;
9292

@@ -193,7 +193,7 @@ impl Database for SqliteDatabase {
193193

194194
Ok(AuthKey {
195195
key,
196-
valid_until: Some(SinceUnixEpoch::from_secs(valid_until_i64 as u64)),
196+
valid_until: Some(DurationSinceUnixEpoch::from_secs(valid_until_i64 as u64)),
197197
})
198198
} else {
199199
Err(database::Error::QueryReturnedNoRows)

‎src/protocol/clock/clock.rs‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use std::num::IntErrorKind;
22
pub use std::time::Duration;
33

4-
pub type SinceUnixEpoch = Duration;
4+
pub type DurationSinceUnixEpoch = Duration;
55

66
#[derive(Debug)]
77
pub enum ClockType {
@@ -22,14 +22,14 @@ pub type DefaultClock = WorkingClock;
2222
pub type DefaultClock = StoppedClock;
2323

2424
pub trait Time: Sized {
25-
fn now() -> SinceUnixEpoch;
25+
fn now() -> DurationSinceUnixEpoch;
2626
}
2727

2828
pub trait TimeNow: Time {
29-
fn add(add_time: &Duration) -> Option<SinceUnixEpoch> {
29+
fn add(add_time: &Duration) -> Option<DurationSinceUnixEpoch> {
3030
Self::now().checked_add(*add_time)
3131
}
32-
fn sub(sub_time: &Duration) -> Option<SinceUnixEpoch> {
32+
fn sub(sub_time: &Duration) -> Option<DurationSinceUnixEpoch> {
3333
Self::now().checked_sub(*sub_time)
3434
}
3535
}
@@ -57,10 +57,10 @@ mod tests {
5757
mod working_clock {
5858
use std::time::SystemTime;
5959

60-
use super::{SinceUnixEpoch, Time, TimeNow, WorkingClock};
60+
use super::{DurationSinceUnixEpoch, Time, TimeNow, WorkingClock};
6161

6262
impl Time for WorkingClock {
63-
fn now() -> SinceUnixEpoch {
63+
fn now() -> DurationSinceUnixEpoch {
6464
SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap()
6565
}
6666
}
@@ -69,9 +69,9 @@ mod working_clock {
6969
}
7070

7171
pub trait StoppedTime: TimeNow {
72-
fn local_set(unix_time: &SinceUnixEpoch);
72+
fn local_set(unix_time: &DurationSinceUnixEpoch);
7373
fn local_set_to_unix_epoch() {
74-
Self::local_set(&SinceUnixEpoch::ZERO)
74+
Self::local_set(&DurationSinceUnixEpoch::ZERO)
7575
}
7676
fn local_set_to_app_start_time();
7777
fn local_set_to_system_time_now();
@@ -84,10 +84,10 @@ mod stopped_clock {
8484
use std::num::IntErrorKind;
8585
use std::time::Duration;
8686

87-
use super::{SinceUnixEpoch, StoppedClock, StoppedTime, Time, TimeNow};
87+
use super::{DurationSinceUnixEpoch, StoppedClock, StoppedTime, Time, TimeNow};
8888

8989
impl Time for StoppedClock {
90-
fn now() -> SinceUnixEpoch {
90+
fn now() -> DurationSinceUnixEpoch {
9191
detail::FIXED_TIME.with(|time| {
9292
return *time.borrow();
9393
})
@@ -97,7 +97,7 @@ mod stopped_clock {
9797
impl TimeNow for StoppedClock {}
9898

9999
impl StoppedTime for StoppedClock {
100-
fn local_set(unix_time: &SinceUnixEpoch) {
100+
fn local_set(unix_time: &DurationSinceUnixEpoch) {
101101
detail::FIXED_TIME.with(|time| {
102102
*time.borrow_mut() = *unix_time;
103103
})
@@ -147,11 +147,11 @@ mod stopped_clock {
147147
use std::thread;
148148
use std::time::Duration;
149149

150-
use crate::protocol::clock::clock::{SinceUnixEpoch, StoppedClock, StoppedTime, Time, TimeNow, WorkingClock};
150+
use crate::protocol::clock::clock::{DurationSinceUnixEpoch, StoppedClock, StoppedTime, Time, TimeNow, WorkingClock};
151151

152152
#[test]
153153
fn it_should_default_to_zero_when_testing() {
154-
assert_eq!(StoppedClock::now(), SinceUnixEpoch::ZERO)
154+
assert_eq!(StoppedClock::now(), DurationSinceUnixEpoch::ZERO)
155155
}
156156

157157
#[test]
@@ -206,26 +206,26 @@ mod stopped_clock {
206206
use std::cell::RefCell;
207207
use std::time::SystemTime;
208208

209-
use crate::protocol::clock::clock::SinceUnixEpoch;
209+
use crate::protocol::clock::clock::DurationSinceUnixEpoch;
210210
use crate::static_time;
211211

212-
pub fn get_app_start_time() -> SinceUnixEpoch {
212+
pub fn get_app_start_time() -> DurationSinceUnixEpoch {
213213
(*static_time::TIME_AT_APP_START)
214214
.duration_since(SystemTime::UNIX_EPOCH)
215215
.unwrap()
216216
}
217217

218218
#[cfg(not(test))]
219-
pub fn get_default_fixed_time() -> SinceUnixEpoch {
219+
pub fn get_default_fixed_time() -> DurationSinceUnixEpoch {
220220
get_app_start_time()
221221
}
222222

223223
#[cfg(test)]
224-
pub fn get_default_fixed_time() -> SinceUnixEpoch {
225-
SinceUnixEpoch::ZERO
224+
pub fn get_default_fixed_time() -> DurationSinceUnixEpoch {
225+
DurationSinceUnixEpoch::ZERO
226226
}
227227

228-
thread_local!(pub static FIXED_TIME: RefCell<SinceUnixEpoch> = RefCell::new(get_default_fixed_time()));
228+
thread_local!(pub static FIXED_TIME: RefCell<DurationSinceUnixEpoch> = RefCell::new(get_default_fixed_time()));
229229

230230
#[cfg(test)]
231231
mod tests {

‎src/protocol/utils.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use std::net::SocketAddr;
22

33
use aquatic_udp_protocol::ConnectionId;
44

5-
use super::clock::clock::{DefaultClock, SinceUnixEpoch, Time};
5+
use super::clock::clock::{DefaultClock, DurationSinceUnixEpoch, Time};
66

77
pub fn get_connection_id(remote_address: &SocketAddr) -> ConnectionId {
88
ConnectionId(((current_time() / 3600) | ((remote_address.port() as u64) << 36)) as i64)
@@ -12,6 +12,6 @@ pub fn current_time() -> u64 {
1212
DefaultClock::now().as_secs()
1313
}
1414

15-
pub fn ser_unix_time_value<S: serde::Serializer>(unix_time_value: &SinceUnixEpoch, ser: S) -> Result<S::Ok, S::Error> {
15+
pub fn ser_unix_time_value<S: serde::Serializer>(unix_time_value: &DurationSinceUnixEpoch, ser: S) -> Result<S::Ok, S::Error> {
1616
ser.serialize_u64(unix_time_value.as_millis() as u64)
1717
}

‎src/tracker/key.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use rand::distributions::Alphanumeric;
66
use rand::{thread_rng, Rng};
77
use serde::Serialize;
88

9-
use crate::protocol::clock::clock::{DefaultClock, SinceUnixEpoch, Time, TimeNow};
9+
use crate::protocol::clock::clock::{DefaultClock, DurationSinceUnixEpoch, Time, TimeNow};
1010
use crate::AUTH_KEY_LENGTH;
1111

1212
pub fn generate_auth_key(lifetime: Duration) -> AuthKey {
@@ -25,7 +25,7 @@ pub fn generate_auth_key(lifetime: Duration) -> AuthKey {
2525
}
2626

2727
pub fn verify_auth_key(auth_key: &AuthKey) -> Result<(), Error> {
28-
let current_time: SinceUnixEpoch = DefaultClock::now();
28+
let current_time: DurationSinceUnixEpoch = DefaultClock::now();
2929
if auth_key.valid_until.is_none() {
3030
return Err(Error::KeyInvalid);
3131
}
@@ -39,7 +39,7 @@ pub fn verify_auth_key(auth_key: &AuthKey) -> Result<(), Error> {
3939
#[derive(Serialize, Debug, Eq, PartialEq, Clone)]
4040
pub struct AuthKey {
4141
pub key: String,
42-
pub valid_until: Option<SinceUnixEpoch>,
42+
pub valid_until: Option<DurationSinceUnixEpoch>,
4343
}
4444

4545
impl AuthKey {

‎src/tracker/peer.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use serde;
55
use serde::Serialize;
66

77
use crate::http::AnnounceRequest;
8-
use crate::protocol::clock::clock::{DefaultClock, SinceUnixEpoch, Time};
8+
use crate::protocol::clock::clock::{DefaultClock, DurationSinceUnixEpoch, Time};
99
use crate::protocol::common::{AnnounceEventDef, NumberOfBytesDef};
1010
use crate::protocol::utils::ser_unix_time_value;
1111
use crate::PeerId;
@@ -15,7 +15,7 @@ pub struct TorrentPeer {
1515
pub peer_id: PeerId,
1616
pub peer_addr: SocketAddr,
1717
#[serde(serialize_with = "ser_unix_time_value")]
18-
pub updated: SinceUnixEpoch,
18+
pub updated: DurationSinceUnixEpoch,
1919
#[serde(with = "NumberOfBytesDef")]
2020
pub uploaded: NumberOfBytes,
2121
#[serde(with = "NumberOfBytesDef")]

0 commit comments

Comments
 (0)