HttpResponse Rust Reference Documentation

HttpResponse

Current Version: 11.6.1

Chilkat.HttpResponse

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Chilkat.HttpResponse represents an HTTP response returned by certain Chilkat.Http methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as BinData, StringBuilder, JsonObject, JsonArray, and Xml.

Status and reason

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

Headers and cookies

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

Body as text or bytes

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

Structured body loading

Load the body directly into JsonObject, JsonArray, Xml, BinData, or StringBuilder objects for further processing.

Redirect information

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

Save and inspect responses

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

Common pattern: Send a request with Chilkat.Http, check the StatusCode, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, BinData, StringBuilder, JSON, or XML. Use HttpResponse for response inspection; use Chilkat.Http for the actual network request.

For an extended overview, see HttpResponse Class Overview.

Object Creation

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::HttpResponse;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let http_response = HttpResponse::new();
// ... the native object is freed when `http_response` goes out of scope.

pub fn new() -> HttpResponse

Creates the underlying native Chilkat object (HttpResponse also implements Default). Every method takes &self, so the object never needs to be declared mut. A HttpResponse is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for HttpResponse

The native object is freed when the HttpResponse is dropped — when it goes out of scope, or explicitly with drop(http_response). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<HttpResponse>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match http_response.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

BodyQP

// read-only
pub fn body_qp(&self) -> String

The same as the Body property, but returned as a quoted-printable encoded string.

HttpResponse Rust Reference Documentation

HttpResponse

Current Version: 11.6.1

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Status and reason

Headers and cookies

Body as text or bytes

Structured body loading

Redirect information

Save and inspect responses

Object Creation

Errors

Properties

BodyQP

BodyStr

Charset

ContentLength

ContentLength64

DateStr

DebugLogFilePath

Domain

FinalRedirectUrl

FullMime

Header

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCookies

NumHeaderFields

StatusCode

StatusLine

StatusText

UncommonOptions

VerboseLogging

Version

Methods

GetBodyBd

GetBodyJarr

GetBodyJson

GetBodySb

GetBodyXml

GetCookieDomain

GetCookieExpiresStr

GetCookieName

GetCookiePath

GetCookieValue

GetHeaderField

GetHeaderFieldAttr

GetHeaderName

GetHeaderValue

SaveBodyBinary

SaveBodyText

UrlEncParamValue