generic_api_client/
lib.rs

1// Warn (almost) everything. see https://doc.rust-lang.org/rustc/lints/groups.html
2#![warn(
3    future_incompatible,
4    let_underscore,
5    nonstandard_style,
6    rust_2018_compatibility,
7    rust_2018_idioms,
8    rust_2021_compatibility,
9    unused,
10    missing_docs,
11)]
12
13//! # Generic-API-Client
14//! This is a crate for interacting with HTTP/HTTPS/WebSocket APIs.
15//! It is named "generic" because you can use the **same** client to interact with **multiple different**
16//! APIs with, different authentication methods, data formats etc.
17//!
18//! This crate  provides
19//! - [Client][http::Client] A HTTP/HTTPS client
20//! - [WebSocketConnection][websocket::WebSocketConnection] A `struct` to manage WebSocket connections
21//! - [RequestHandler][http::RequestHandler] A `trait` for implementing features like authentication on your requests
22//! - [WebSocketHandler][websocket::WebSocketHandler] A `trait` that is used to handle messages etc.. for a WebSocket Connection.
23//!
24//! For a more detailed documentation, see the links above.
25
26/// Module for interacting with HTTP/HTTPS APIs.
27pub mod http;
28/// Module for interacting with WebSocket APIs.
29pub mod websocket;