gorb/bunny-api-tokio
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update docs to reflect current code

Browse source
This commit is contained in:
Radical 2025-06-25 14:08:15 +02:00
parent 914db27a98
commit ce50afa635
3 changed files with 28 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/bunny/mod.rs
View file

@ -1,4 +1,4 @@
//! Contains structs, enums and implementations for the main bunny.net API
//! Contains structs, enums and implementations for the main Bunny.net API
use url::Url;
@ -24,7 +24,7 @@ pub struct BunnyClient {
}
impl BunnyClient {
/// Creates a new BunnyClient using the supplied `api_key`
/// Creates a new Bunny.net API Client using the supplied `api_key`
///
/// ```
/// use bunny_api_tokio::{BunnyClient, error::Error};
@ -54,12 +54,12 @@ impl BunnyClient {
/// Returns a list of countries and tax rates
///
/// ```
/// use bunny_api_tokio::{Client, error::Error};
/// use bunny_api_tokio::{BunnyClient, error::Error};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// // Bunny.net api key
/// let mut client = Client::new("api_key").await?;
/// let mut client = BunnyClient::new("api_key").await?;
///
/// let countries = client.get_country_list().await?;
///
@ -87,12 +87,12 @@ impl BunnyClient {
/// Returns a list of API Keys
///
/// ```
/// use bunny_api_tokio::{Client, error::Error};
/// use bunny_api_tokio::{BunnyClient, error::Error};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// // Bunny.net api key
/// let mut client = Client::new("api_key").await?;
/// let mut client = BunnyClient::new("api_key").await?;
///
/// let api_keys = client.list_api_keys(1, 1000).await?;
///
@ -124,12 +124,12 @@ impl BunnyClient {
/// Returns a list of Regions
///
/// ```
/// use bunny_api_tokio::{Client, error::Error};
/// use bunny_api_tokio::{BunnyClient, error::Error};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// // Bunny.net api key
/// let mut client = Client::new("api_key").await?;
/// let mut client = BunnyClient::new("api_key").await?;
///
/// let regions = client.region_list().await?;
///
@ -156,12 +156,12 @@ impl BunnyClient {
/// Purges a URL from the cache
///
/// ```
/// use bunny_api_tokio::{Client, error::Error};
/// use bunny_api_tokio::{BunnyClient, error::Error};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// // Bunny.net api key
/// let mut client = Client::new("api_key").await?;
/// let mut client = BunnyClient::new("api_key").await?;
///
/// client.purge_url("https://url_to_purge.com".parse()?, false).await?;
///

34
src/edge_storage/mod.rs
View file

@ -20,7 +20,7 @@ pub struct EdgeStorageClient {
}
impl<'a> EdgeStorageClient {
/// Creates a new EdgeStorageClient using the supplied `api_key`
/// Creates a new EdgeStorageClient
///
/// ```
/// use bunny_api_tokio::{EdgeStorageClient, error::Error, edge_storage::Endpoint};
@ -53,19 +53,17 @@ impl<'a> EdgeStorageClient {
/// Uploads a file to the Storage Zone
///
/// ```
/// use bunny_api_tokio::{Client, error::Error, edge_storage::Endpoint};
/// use bunny_api_tokio::{EdgeStorageClient, error::Error, edge_storage::Endpoint};
/// use tokio::fs;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// let mut client = Client::new("api_key").await?;
///
/// client.storage.init("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
/// let mut client = EdgeStorageClient::new("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
///
/// let file_bytes = fs::read("path/to/file.png").await.unwrap();
///
/// // Will put a file in STORAGE_ZONE/images/file.png
/// client.storage.upload("/images/file.png", file_bytes.into()).await?;
/// client.upload("/images/file.png", file_bytes.into()).await?;
///
/// Ok(())
/// }
@ -91,18 +89,16 @@ impl<'a> EdgeStorageClient {
/// Downloads a file from the Storage Zone
///
/// ```
/// use bunny_api_tokio::{Client, error::Error, edge_storage::Endpoint};
/// use bunny_api_tokio::{EdgeStorageClient, error::Error, edge_storage::Endpoint};
/// use tokio::fs;
/// use tokio::io::AsyncWriteExt;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// let mut client = Client::new("api_key").await?;
///
/// client.storage.init("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
/// let mut client = EdgeStorageClient::new("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
///
/// // Will download the file STORAGE_ZONE/images/file.png
/// let contents = client.storage.download("/images/file.png").await?;
/// let contents = client.download("/images/file.png").await?;
///
/// let mut file = fs::File::create("file.png").await.unwrap();
/// file.write_all(&contents).await.unwrap();
@ -130,16 +126,14 @@ impl<'a> EdgeStorageClient {
/// Deletes a file from the Storage Zone
///
/// ```
/// use bunny_api_tokio::{Client, error::Error, edge_storage::Endpoint};
/// use bunny_api_tokio::{EdgeStorageClient, error::Error, edge_storage::Endpoint};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// let mut client = Client::new("api_key").await?;
///
/// client.storage.init("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
/// let mut client = EdgeStorageClient::new("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
///
/// // Will delete the file STORAGE_ZONE/images/file.png
/// client.storage.delete("/images/file.png").await?;
/// client.delete("/images/file.png").await?;
///
/// Ok(())
/// }
@ -163,16 +157,14 @@ impl<'a> EdgeStorageClient {
/// Lists files on the Storage Zone
///
/// ```
/// use bunny_api_tokio::{Client, error::Error, edge_storage::Endpoint};
/// use bunny_api_tokio::{EdgeStorageClient, error::Error, edge_storage::Endpoint};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
/// let mut client = Client::new("api_key").await?;
///
/// client.storage.init("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
/// let mut client = EdgeStorageClient::new("storage_zone_api_key", Endpoint::Frankfurt, "MyStorageZone").await?;
///
/// // Will list the files in STORAGE_ZONE/images/
/// let files = client.storage.list("/images/").await?;
/// let files = client.list("/images/").await?;
///
/// println!("{:#?}", files);
///

4
src/lib.rs
View file

@ -8,11 +8,11 @@
//! 2. Start coding
//!
//! ```
//! use bunny_api_tokio::{Client, error::Error};
//! use bunny_api_tokio::{BunnyClient, error::Error};
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Error> {
//! let mut client = Client::new("api_key").await?;
//! let mut client = BunnyClient::new("api_key").await?;
//!
//! Ok(())
//! }