Struct APIResponse 

pub struct APIResponse { /* private fields */ }

Response from an API request.

This struct wraps a reqwest response and provides convenient methods for extracting the response body in various formats.

Example

use viewpoint_core::api::{APIRequestContext, APIContextOptions};

let api = APIRequestContext::new(APIContextOptions::new()).await?;
let response = api.get("https://api.example.com/users").send().await?;

// Check status
if response.ok() {
    // Parse JSON
    let data: serde_json::Value = response.json().await?;
    println!("Got data: {:?}", data);
}

Implementations

impl APIResponse

pub fn status(&self) -> u16

Get the HTTP status code.

Example

let response = api.get("https://api.example.com/users").send().await?;
println!("Status: {}", response.status()); // e.g., 200

pub fn status_code(&self) -> StatusCode

Get the HTTP status code as a reqwest::StatusCode.

pub fn ok(&self) -> bool

Check if the response was successful (status code 2xx).

Example

let response = api.get("https://api.example.com/users").send().await?;
if response.ok() {
    println!("Request succeeded!");
}

pub fn status_text(&self) -> &str

Get the status text (reason phrase).

pub fn headers(&self) -> &HeaderMap

Get the response headers.

Example

let response = api.get("https://api.example.com/users").send().await?;
let headers = response.headers();
if let Some(content_type) = headers.get("content-type") {
    println!("Content-Type: {:?}", content_type);
}

pub fn headers_map(&self) -> HashMap<String, String>

Get response headers as a HashMap.

pub fn header(&self, name: &str) -> Option<&str>

Get a specific header value.

pub fn url(&self) -> &str

Get the final URL after any redirects.

pub async fn json<T: DeserializeOwned>(self) -> Result<T, APIError>

Parse the response body as JSON.

Errors

Returns an error if the response body cannot be parsed as JSON.

Example

use serde::Deserialize;

#[derive(Deserialize)]
struct User {
    id: i32,
    name: String,
}

let response = api.get("https://api.example.com/users/1").send().await?;
let user: User = response.json().await?;
println!("User: {} (id={})", user.name, user.id);

pub async fn text(self) -> Result<String, APIError>

Get the response body as text.

Errors

Returns an error if the response body cannot be read as text.

Example

let response = api.get("https://example.com").send().await?;
let html = response.text().await?;
println!("HTML length: {} bytes", html.len());

pub async fn body(self) -> Result<Bytes, APIError>

Get the response body as raw bytes.

Errors

Returns an error if the response body cannot be read.

Example

let response = api.get("https://example.com/image.png").send().await?;
let bytes = response.body().await?;
std::fs::write("image.png", &bytes).expect("Failed to write file");

pub fn content_length(&self) -> Option<u64>

Get the content length if known.

pub fn is_redirect(&self) -> bool

Check if the response indicates a redirect.

pub fn is_client_error(&self) -> bool

Check if the response indicates a client error (4xx).

pub fn is_server_error(&self) -> bool

Check if the response indicates a server error (5xx).

Trait Implementations

impl Debug for APIResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.