qrsync/
lib.rs

1#![forbid(unsafe_code)]
2#![warn(missing_docs, missing_debug_implementations)]
3
4//! ## QrSync
5//! Utility to copy files over WiFi to/from mobile devices inside a terminal.
6//!
7//! When I built QrSync, it was only meant to send files from a terminal to a mobile device, then I
8//! found the amazing [qrcp](https://github.com/claudiodangelis/qrcp) and I took some ideas from it and
9//! implemented also the possibility to copy file from the mobile device to the computer running QrSync.
10//!
11//! ### Acknowledgement
12//! * [qrcp](https://github.com/claudiodangelis/qrcp): I took many ideas from this amazing project
13//! and "stole" most of the HTML Bootstrap based UI.
14//! * [axum](https://github.com/tokio-rs/axum): A great HTTP framework for Rust, very expandable and simple to
15//! use.
16//! * [qr2term](https://docs.rs/qr2term/): Terminal based QR rendering library.
17//! * [clap](https://clap.rs/): Oh man, where do I start telling how much do I love Clap?
18//!
19//! See Github project [README](https://github.com/crisidev/qrsync/blob/master/README.md) for more
20//! info.
21
22mod error;
23mod http;
24mod routes;
25
26pub use error::QrSyncError;
27pub use http::QrSyncHttp;
28
29/// Handy type handling Result and Errors.
30pub type QrSyncResult<T> = Result<T, QrSyncError>;