spoo_me/lib.rs
1//! Rust bindings for accessing the spoo.me API
2//!
3//! This crate provides a client that can access all endpoints provided by spoo.me, with support for self hosted instances of it.
4//!
5//! Currently this library does not have a public documentation site, however running `cargo doc` will provide some information.
6//!
7//! <br>
8//!
9//! # Features
10//! - `blocking`: Enables blocking methods for the client, allowing synchronous calls to the API.
11//! - `custom_url`: Allows setting a custom base URL for the client, useful for self-hosted instances of spoo.me.
12
13#![warn(missing_docs)]
14#![warn(clippy::all)]
15
16/// A client for the URL shortener API.
17pub mod client;
18
19/// Errors related to a request.
20pub mod errors;
21
22/// Requests and responses for the URL shortener API.
23pub mod requests;
24
25/// Tools for validating and formatting requests.
26pub mod utils;