1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
// Copyright 2017 rust-ipfs-api Developers // // Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or // http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or // http://opensource.org/licenses/MIT>, at your option. This file may not be // copied, modified, or distributed except according to those terms. // #![recursion_limit = "128"] //! Rust library for connecting to the IPFS HTTP API using tokio. //! //! ## Usage //! //! ```toml //! [dependencies] //! ipfs-api = "0.8.0-rc.2" //! ``` //! //! You can use `actix-web` as a backend instead of `hyper`. //! //! ```toml //! [dependencies] //! ipfs-api = { version = "0.8.0-rc.2", features = ["actix"], default-features = false } //! ``` //! //! ## Examples //! //! ### Writing a file to IPFS //! //! #### With Hyper //! //! ```no_run //! use ipfs_api::IpfsClient; //! use std::io::Cursor; //! //! #[tokio::main] //! async fn main() { //! let client = IpfsClient::default(); //! let data = Cursor::new("Hello World!"); //! //! match client.add(data).await { //! Ok(res) => println!("{}", res.hash), //! Err(e) => eprintln!("error adding file: {}", e) //! } //! } //! ``` //! //! #### With Actix //! //! ```no_run //! use ipfs_api::IpfsClient; //! use std::io::Cursor; //! //! #[actix_rt::main] //! async fn main() { //! let client = IpfsClient::default(); //! let data = Cursor::new("Hello World!"); //! //! match client.add(data).await { //! Ok(res) => println!("{}", res.hash), //! Err(e) => eprintln!("error adding file: {}", e) //! } //! } //! ``` //! //! ### Reading a file from IPFS //! //! #### With Hyper //! //! ```no_run //! use futures::TryStreamExt; //! use ipfs_api::IpfsClient; //! use std::io::{self, Write}; //! //! #[tokio::main] //! async fn main() { //! let client = IpfsClient::default(); //! //! match client //! .get("/test/file.json") //! .map_ok(|chunk| chunk.to_vec()) //! .try_concat() //! .await //! { //! Ok(res) => { //! let out = io::stdout(); //! let mut out = out.lock(); //! //! out.write_all(&res).unwrap(); //! } //! Err(e) => eprintln!("error getting file: {}", e) //! } //! } //! ``` //! //! #### With Actix //! //! ```no_run //! use futures::TryStreamExt; //! use ipfs_api::IpfsClient; //! use std::io::{self, Write}; //! //! #[actix_rt::main] //! async fn main() { //! let client = IpfsClient::default(); //! //! match client //! .get("/test/file.json") //! .map_ok(|chunk| chunk.to_vec()) //! .try_concat() //! .await //! { //! Ok(res) => { //! let out = io::stdout(); //! let mut out = out.lock(); //! //! out.write_all(&res).unwrap(); //! } //! Err(e) => eprintln!("error getting file: {}", e) //! } //! } //! ``` //! //! ### Additional Examples //! //! There are also a bunch of examples included in the project, which //! I used for testing //! //! For a list of examples, run: //! //! ```sh //! $ cargo run --example //! ``` //! //! You can run any of the examples with cargo: //! //! ```sh //! $ cargo run --example add_file //! ``` //! #[cfg(feature = "actix")] extern crate actix_multipart_rfc7578 as actix_multipart; #[cfg(feature = "actix")] #[macro_use] extern crate derive_more; #[cfg(feature = "hyper")] extern crate hyper_multipart_rfc7578 as hyper_multipart; #[cfg(feature = "hyper")] #[macro_use] extern crate failure; extern crate serde; #[cfg(feature = "builder")] #[macro_use] extern crate typed_builder; pub use crate::client::{IpfsClient, TryFromUri}; pub use crate::request::{KeyType, Logger, LoggingLevel, ObjectTemplate}; mod client; mod header; mod read; pub mod request; pub mod response; #[cfg(feature = "actix")] use actix_http::{encoding, Payload, PayloadStream}; #[cfg(feature = "hyper")] use hyper::{self, client::HttpConnector}; #[cfg(feature = "hyper")] use hyper_tls::HttpsConnector; #[cfg(feature = "actix")] pub(crate) type Request = awc::SendClientRequest; #[cfg(feature = "hyper")] pub(crate) type Request = http::Request<hyper::Body>; #[cfg(feature = "actix")] pub(crate) type Response = awc::ClientResponse<encoding::Decoder<Payload<PayloadStream>>>; #[cfg(feature = "hyper")] pub(crate) type Response = http::Response<hyper::Body>; #[cfg(feature = "actix")] pub(crate) type Client = awc::Client; #[cfg(feature = "hyper")] pub(crate) type Client = hyper::client::Client<HttpsConnector<HttpConnector>, hyper::Body>;