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

// Copyright 2017 Lyndon Brown
//
// This file is part of the PulseAudio Rust language binding.
//
// Licensed under the MIT license or the Apache license (version 2.0), at your option. You may not
// copy, modify, or distribute this file except in compliance with said license. You can find copies
// of these licenses either in the LICENSE-MIT and LICENSE-APACHE files, or alternatively at
// <http://opensource.org/licenses/MIT> and <http://www.apache.org/licenses/LICENSE-2.0>
// respectively.
//
// Portions of documentation are copied from the LGPL 2.1+ licensed PulseAudio C headers on a
// fair-use basis, as discussed in the overall project readme (available in the git repository).

//! Time handling functionality.

mod convert; //private!
mod microseconds;
mod monotonic;
mod timeval;
mod unix;

use std::convert::TryFrom;
use std::time::Duration;

pub use self::microseconds::*;
pub use self::monotonic::*;
pub use self::timeval::*;
pub use self::unix::*;

// (Copied constants from rust’s std/time/duration.rs)
/// Nanoseconds per second.
pub const NANOS_PER_SEC:    u32 = 1_000_000_000;
/// Nanoseconds per millisecond.
pub const NANOS_PER_MILLI:  u32 = 1_000_000;
/// Nanoseconds per microsecond.
pub const NANOS_PER_MICRO:  u32 = 1_000;
/// Microseconds per second.
pub const MICROS_PER_SEC:   u64 = 1_000_000;
/// Microseconds per millisecond.
pub const MICROS_PER_MILLI: u64 = 1_000;
/// Milliseconds per second.
pub const MILLIS_PER_SEC:   u64 = 1_000;

/// Invalid time. Microseconds value representing ‘invalid’.
#[deprecated(since = "2.20.0", note="use the associated constant on `MicroSeconds` instead")]
pub const USEC_INVALID: MicroSeconds = MicroSeconds(capi::PA_USEC_INVALID);

/// Largest valid time value in microseconds (largest integer value is reserved for representing
/// ‘invalid’).
#[deprecated(since = "2.20.0", note="use the associated constant on `MicroSeconds` instead")]
pub const USEC_MAX: MicroSeconds = MicroSeconds(capi::PA_USEC_MAX);

/// Basic math operation errors.
mod op_err {
    pub const ADD: &str = "attempt to add with overflow";
    pub const SUB: &str = "attempt to subtract with overflow";
    pub const MUL: &str = "attempt to multiply with overflow";
    pub const DIV: &str = "attempt to divide by zero";
    pub const REM: &str = DIV;
}