Struct sciter::request::Request

pub struct Request(_);

Request object.

Can be constructed from a HREQUEST handle only:

fn on_data_load(pnm: &mut SCN_LOAD_DATA) -> Option<LOAD_RESULT> {
  let mut rq = Request::from(pnm.request_id);
  // ...
}

Implementations

impl Request

pub fn succeeded(&mut self, status: u32, data: Option<&[u8]>) -> Result<()>

Mark the request as complete with status and optional data.

pub fn failed(&mut self, status: u32, data: Option<&[u8]>) -> Result<()>

Mark the request as complete with failure.

pub fn append_received_data(&mut self, data: &[u8]) -> Result<()>

Append a data chunk to the received data.

pub fn get_received_data(&self) -> Result<Vec<u8>>

Get received (so far) data.

pub fn url(&self) -> Result<String>

Get the URL of the request.

pub fn content_url(&self) -> Result<String>

Get a real URL of the content (e.g., after possible redirection).

pub fn method(&self) -> Result<REQUEST_METHOD>

Get the data type of the request.

pub fn request_type(&self) -> Result<RESOURCE_TYPE>

Get the resource data type of the request.

pub fn response_type(&self) -> Result<String>

Get the MIME type of the received data.

pub fn set_response_type(&mut self, mime_type: &str) -> Result<()>

Set the MIME type of the received data.

pub fn set_response_encoding(&mut self, encoding_type: &str) -> Result<()>

Set the data encoding for the received data.

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

Get the parameters of the request.

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

Get the headers of the request.

pub fn set_request_header(&mut self, name: &str, value: &str) -> Result<()>

Set request header (a single item).

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

Get the headers of the response.

pub fn set_response_header(&mut self, name: &str, value: &str) -> Result<()>

Set respone header (a single item).

pub fn proxy(&self) -> Result<(String, u16)>

Get proxy host and port (if any).

pub fn completion_status(&self) -> Result<(REQUEST_STATE, u32)>

Get the current completion status of the request.

Returns current state and HTTP response code.

pub fn request_duration(&self) -> Result<Duration>

Get the execution duratiom of the request.

pub fn request_time(&self) -> Result<(Duration, Duration)>

Get the execution started and ended time of the request, in milliseconds.

Trait Implementations

impl Clone for Request

Copies the object.

All allocated objects are reference counted so copying is just a matter of increasing reference counts.

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Request

Destroy the object.

fn drop(&mut self)

Executes the destructor for this type.

impl From<*mut _HREQUEST> for Request

Construct a Request object from HREQUEST handle.

fn from(hrq: HREQUEST) -> Request

Performs the conversion.