carbonfr_sdk/lib.rs
1//! # carbonfr-sdk
2//!
3//! Client Rust **asynchrone** (tokio) de l'API [carbon-fr](https://github.com/Kovelt/carbon-fr)
4//! — intensité carbone de l'électricité française (gCO₂eq/kWh), temps réel et
5//! historique.
6//!
7//! ```no_run
8//! # #[cfg(feature = "stream")]
9//! # async fn go() -> Result<(), carbonfr_sdk::CarbonFrError> {
10//! use carbonfr_sdk::{CarbonFr, IntensityStreamOptions};
11//! use futures_util::StreamExt;
12//!
13//! let client = CarbonFr::builder().build()?;
14//! let mut stream = client.intensity_stream(IntensityStreamOptions::default())?;
15//! while let Some(event) = stream.next().await {
16//! println!("{:?}", event?);
17//! }
18//! # Ok(())
19//! # }
20//! ```
21//!
22//! ## Couverture
23//!
24//! **Parité avec les 29 opérations `/v1`** du SDK TypeScript 0.5.0
25//! (ADR-0031 décision 8 ; `health`/`health_ready`, d'exploitation, ne sont pas
26//! exposées) : construction du client ([`CarbonFr`]/[`CarbonFrBuilder`]),
27//! erreurs typées ([`CarbonFrError`], RFC 9457), 28 méthodes REST (ex.
28//! [`CarbonFr::intensity_now`], [`CarbonFr::mix`], [`CarbonFr::schedule`],
29//! [`CarbonFr::create_webhook`]…) et le flux SSE `CarbonFr::intensity_stream`
30//! (feature Cargo `stream`). Exemples exécutables dans `examples/` du dépôt.
31//!
32//! ## Construction TLS (ADR-0031 décision 3)
33//!
34//! `reqwest` 0.13 sans provider crypto installé **panique** à la construction
35//! d'un client. Ce SDK ne s'appuie **jamais** sur un provider par défaut du
36//! **processus** (`rustls::crypto::CryptoProvider::get_default()` /
37//! `install_default()`, utilisés par `bin/server` et les adapters de ce
38//! dépôt) : il construit son propre `rustls::ClientConfig` avec le provider
39//! `ring` passé **explicitement**, et le donne à `reqwest` via
40//! `ClientBuilder::tls_backend_preconfigured`. Utilisable tel quel dans un
41//! process qui n'installe aucun provider par défaut — voir
42//! `client::tests::crypto_provider_default_stays_uninstalled`.
43
44mod client;
45mod dto;
46mod enums;
47mod error;
48mod methods;
49mod options;
50mod query;
51mod region;
52#[cfg(feature = "stream")]
53mod stream;
54
55pub use client::{
56 CarbonFr, CarbonFrBuilder, DEFAULT_BASE_URL, DEFAULT_CONNECT_TIMEOUT, DEFAULT_TIMEOUT,
57};
58pub use dto::*;
59pub use enums::{
60 EligibilityFramework, EligibilitySignalProvenance, EligibilitySignalVerdict, Estimator,
61 FlowDirection, IntensityIndex, Interval, Methodology, ThresholdDirection, WebhookStatus,
62};
63pub use error::{CarbonFrError, ProblemDetails};
64pub use options::*;
65pub use region::Region;
66#[cfg(feature = "stream")]
67pub use stream::{
68 DEFAULT_IDLE_TIMEOUT, IntensityEvent, IntensityStream, IntensityStreamOptions, Reconnect,
69 StreamConfig,
70};