diff options
| author | Ferris Tseng <ferristseng@fastmail.fm> | 2021-02-23 23:24:47 -0500 |
|---|---|---|
| committer | Ferris Tseng <ferristseng@fastmail.fm> | 2021-02-23 23:24:47 -0500 |
| commit | 306f307222358047ace385bb4126d9571858497f (patch) | |
| tree | 69c0ffa0a838074b33cd20ec628497e68847ca3e | |
| parent | 2d32fa5de144690fcd7d26064a1a4e66c5a7c0b4 (diff) | |
add some documentation
| -rw-r--r-- | ipfs-api-prelude/src/backend.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/ipfs-api-prelude/src/backend.rs b/ipfs-api-prelude/src/backend.rs index 433cf4a..f2505ca 100644 --- a/ipfs-api-prelude/src/backend.rs +++ b/ipfs-api-prelude/src/backend.rs @@ -37,6 +37,8 @@ pub trait Backend: Default { /// type Error: Display + From<ApiError> + From<crate::Error> + 'static; + /// Builds the url for an api call. + /// fn build_base_request<Req>( &self, req: &Req, @@ -45,8 +47,12 @@ pub trait Backend: Default { where Req: ApiRequest; + /// Get the value of a header from an HTTP response. + /// fn get_header<'a>(res: &'a Self::HttpResponse, key: HeaderName) -> Option<&'a HeaderValue>; + /// Generates a request, and returns the unprocessed response future. + /// async fn request_raw<Req>( &self, req: Req, @@ -59,6 +65,9 @@ pub trait Backend: Default { res: Self::HttpResponse, ) -> Box<dyn Stream<Item = Result<Bytes, Self::Error>> + Unpin>; + /// Generic method for making a request that expects back a streaming + /// response. + /// fn request_stream<Res, F, OutStream>( &self, req: Self::HttpRequest, |