mirror of https://github.com/MedzikUser/imgurs
65 lines
1.7 KiB
Rust
65 lines
1.7 KiB
Rust
//! [![github]](https://github.com/MedzikUser/imgurs)
|
|
//! [![crates-io]](https://crates.io/crates/imgurs)
|
|
//! [![docs-rs]](https://docs.rs/imgurs)
|
|
//!
|
|
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
|
|
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
|
|
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
|
|
//!
|
|
//! This crate is an unofficial implementation of the [Imgur API](https://imgur.com) in Rust.
|
|
//!
|
|
//! # Installation
|
|
//!
|
|
//! ## Requirements
|
|
//! - Rust 1.58 (earlier versions are not tested (only the latest stable version is tested!))
|
|
//! - Network connection
|
|
//!
|
|
//! ## Importing
|
|
//! The driver is available on [crates.io](https://crates.io/crates/imgurs). To use the driver in
|
|
//! your application, simply add it to your project's `Cargo.toml`.
|
|
//! ```toml
|
|
//! [dependencies]
|
|
//! imgurs = "0.8.0"
|
|
//! ```
|
|
//!
|
|
//! # Example Usage
|
|
//!
|
|
//! ## Create new ImgurClient
|
|
//! ```
|
|
//! use imgurs::ImgurClient;
|
|
//!
|
|
//! let client = ImgurClient::new("client id");
|
|
//! ```
|
|
//!
|
|
//! ## Image Upload
|
|
//! ```ignore
|
|
//! // From URL
|
|
//! let info = client.upload_image("https://i.imgur.com/lFaGr1x.png").await?;
|
|
//!
|
|
//! // From File
|
|
//! let info = client.upload_image("path/to/image.png").await?;
|
|
//! ```
|
|
//!
|
|
//! ## Delete Image
|
|
//! ```ignore
|
|
//! client.delete_image("Delete Hash").await?; // delete hash
|
|
//! ```
|
|
//!
|
|
//! ## Get Image Info
|
|
//! ```ignore
|
|
//! let info = client.image_info("lFaGr1x").await?; // image id
|
|
//!
|
|
//! println!("{:?}", info);
|
|
//! ```
|
|
//!
|
|
//! ## Get Client RateLimit
|
|
//! ```ignore
|
|
//! let info = client.rate_limit.await?;
|
|
//!
|
|
//! println!("{:?}", info);
|
|
//! ```
|
|
|
|
mod api;
|
|
|
|
pub use api::*;
|