pub struct Retrofit { /* private fields */ }
Expand description
Retrofit HTTP client
Implementations§
Source§impl Retrofit
impl Retrofit
Sourcepub fn builder() -> RetrofitBuilder
pub fn builder() -> RetrofitBuilder
Create a new builder
Sourcepub async fn execute<T: DeserializeOwned>(
&self,
request: RequestBuilder,
) -> Result<T>
pub async fn execute<T: DeserializeOwned>( &self, request: RequestBuilder, ) -> Result<T>
Execute a request and return deserialized response
§Type Parameters
T
- The type to deserialize the response into. Must implementDeserializeOwned
.
§Arguments
request
- The request to execute, built usingRequestBuilder
§Errors
Returns an error if:
- The HTTP request fails (network error, timeout, etc.)
- The response status is not 2xx
- The response body cannot be deserialized into type
T
§Example
let client = Retrofit::builder()
.base_url("https://api.example.com")
.build()?;
let request = client.get("/users/1");
let user: User = client.execute(request).await?;
Sourcepub async fn execute_text(&self, request: RequestBuilder) -> Result<String>
pub async fn execute_text(&self, request: RequestBuilder) -> Result<String>
Execute request and return raw response body text
Sourcepub fn get(&self, path: &str) -> RequestBuilder
pub fn get(&self, path: &str) -> RequestBuilder
Create a GET request builder
Sourcepub fn post(&self, path: &str) -> RequestBuilder
pub fn post(&self, path: &str) -> RequestBuilder
Create a POST request builder
Sourcepub fn put(&self, path: &str) -> RequestBuilder
pub fn put(&self, path: &str) -> RequestBuilder
Create a PUT request builder
Sourcepub fn delete(&self, path: &str) -> RequestBuilder
pub fn delete(&self, path: &str) -> RequestBuilder
Create a DELETE request builder
Sourcepub fn patch(&self, path: &str) -> RequestBuilder
pub fn patch(&self, path: &str) -> RequestBuilder
Create a PATCH request builder
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Retrofit
impl !RefUnwindSafe for Retrofit
impl Send for Retrofit
impl Sync for Retrofit
impl Unpin for Retrofit
impl !UnwindSafe for Retrofit
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more