aisil 0.3.2

A lightweight framework to define APIs as types
Documentation 
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

//! Simple tracing combinator.

use crate::{HasMethod, ImplsMethod, IsApi};
use core::fmt::Debug;

/// Simple tracing combinator.
///
/// Adds a span and can optionally trace requests, responses and errors.
///
/// **Implementor** combinator.
#[derive(Debug, Clone, Copy)]
pub struct ApiTracer<E>(pub ApiTracerConfig, pub E);

/// Parameters to [`ApiTracer`]. By default only logs errors.
#[derive(Debug, Clone, Copy)]
pub struct ApiTracerConfig {
  /// Enable `debug!("Request: {req:?}")`, default: `false`.
  pub request: bool, // TODO: tracing::level_filters::LevelFilter or similar
  /// Enable `debug!("Response: {res:?}")`, default: `false`.
  pub response: bool,
  /// Enable `error!("{err:?}")`, default: `true`.
  pub error: bool,
}

impl Default for ApiTracerConfig {
  fn default() -> Self {
    Self { request: false, response: false, error: true }
  }
}

impl<API, E, Req, Res, Err> ImplsMethod<API, Req> for ApiTracer<E>
where
  Err: Debug, // TODO: use Display?
  E: Send + Sync,
  E: ImplsMethod<API, Req>,
  Req: Send + Debug,
  Res: Debug,
  API: IsApi + HasMethod<Req, Res = Result<Res, Err>>,
{
  #[rustfmt::skip]
  #[tracing::instrument(skip_all, fields(API = API::API_NAME, method = API::METHOD_NAME))]
  async fn call_api(&self, req: Req) -> Result<Res, Err> {
    let when = &self.0;
    if when.request { tracing::debug!("Request: {req:?}") }
    self.1.call_api(req).await
      .inspect(|r| if when.response {tracing::debug!("Response: {r:?}")})
      .inspect_err(|e| if when.error {tracing::error!("{e:?}")})
  }
}