Merge pull request #131 from nathan-at-least/type-alias-for-clearer-docs

Switch from `use … as IpfsClient` to type aliases for clearer API docs.
ferristseng · Aug 31, 2023 · 81da5ec · 81da5ec
2 parents 33e0149 + d758991
commit 81da5ec
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/ipfs-api-backend-actix/src/lib.rs b/ipfs-api-backend-actix/src/lib.rs
@@ -25,7 +25,8 @@ extern crate actix_multipart_rfc7578 as multipart;
 mod backend;
 mod error;
 
-pub use crate::{backend::ActixBackend as IpfsClient, error::Error};
+pub type IpfsClient = ActixBackend;
+pub use crate::{backend::ActixBackend, error::Error};
 pub use ipfs_api_prelude::{
     request::{self, KeyType, Logger, LoggingLevel, ObjectTemplate},
     response, ApiError, BackendWithGlobalOptions, GlobalOptions, IpfsApi, TryFromUri,

diff --git a/ipfs-api-backend-hyper/src/lib.rs b/ipfs-api-backend-hyper/src/lib.rs
@@ -25,7 +25,8 @@ extern crate hyper_multipart_rfc7578 as multipart;
 mod backend;
 mod error;
 
-pub use crate::{backend::HyperBackend as IpfsClient, error::Error};
+pub type IpfsClient = HyperBackend;
+pub use crate::{backend::HyperBackend, error::Error};
 pub use ipfs_api_prelude::{
     request::{self, KeyType, Logger, LoggingLevel, ObjectTemplate},
     response, ApiError, BackendWithGlobalOptions, GlobalOptions, IpfsApi, TryFromUri,