augmented_audio_metrics/
lib.rs

1// Augmented Audio: Audio libraries and applications
2// Copyright (c) 2022 Pedro Tacla Yamada
3//
4// The MIT License (MIT)
5//
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to deal
8// in the Software without restriction, including without limitation the rights
9// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10// copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22// THE SOFTWARE.
23//! Small helpers for augmented applications.
24//!
25//! * [`audio_processor_metrics`] exposes structs/functions for tracking CPU usage on the
26//!   audio-thread
27use std::time::Instant;
28
29pub mod audio_processor_metrics;
30
31/// Log duration of a function
32pub fn time<T>(label: &str, body: impl FnOnce() -> T) -> T {
33    let start = Instant::now();
34    let result = body();
35    log::info!("{} duration={}ms", label, start.elapsed().as_millis());
36    result
37}
38
39#[cfg(test)]
40mod test {
41    use super::*;
42
43    #[test]
44    fn test_time() {
45        let result = time("test_time", || 10_i32.pow(2));
46        assert_eq!(result, 100);
47    }
48}