Struct stdweb::web::XmlHttpRequest

pub struct XmlHttpRequest(_);

Use XmlHttpRequest (XHR) objects to interact with servers. You can retrieve data from a URL without having to do a full page refresh. This enables a Web page to update just part of a page without disrupting what the user is doing. XmlHttpRequest is used heavily in Ajax programming.

(JavaScript docs)

Methods

impl XmlHttpRequest

pub fn new() -> XmlHttpRequest

Creates new XmlHttpRequest.

pub fn ready_state(&self) -> XhrReadyState

Returns the current state of the request as a XhrReadyState.

(JavaScript docs)

pub fn response_type(&self) -> XhrResponseType

Returns the type of the request as a XhrResponseType

(JavaScript docs)

pub fn set_response_type(
    &self,
    kind: XhrResponseType
) -> Result<(), XhrSetResponseTypeError>

Set the type that the XmlHttpRequest should return

(JavaScript docs)

pub fn response_text(&self) -> Result<Option<String>, TODO>

Returns a string that contains the response to the request as text, or None if the request was unsuccessful or has not yet been sent.

(JavaScript docs)

pub fn raw_response(&self) -> Value

Returns the object representing the response

(JavaScript docs)

pub fn status(&self) -> u16

Returns an unsigned short with the status of the response of the request.

(JavaScript docs)

pub fn open(&self, method: &str, url: &str) -> Result<(), TODO>

Open connection with given method (ie GET or POST), and the url to hit.

(JavaScript docs)

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

Returns the string containing the text of the specified header. If there are multiple response headers with the same name, then their values are returned as a single concatenated string.

(JavaScript docs)

pub fn set_request_header(&self, header: &str, value: &str) -> Result<(), TODO>

Sets the value of an HTTP request header. Must be called after open(), but before send(). If this method is called several times with the same header, the values are merged into one single request header.

(JavaScript docs)

pub fn send(&self) -> Result<(), TODO>

Send request on an open connection with no data

(JavaScript docs)

pub fn send_with_string(&self, body: &str) -> Result<(), TODO>

Send request on an open connection with string body

(JavaScript docs)

pub fn send_with_bytes(&self, body: &[u8]) -> Result<(), TODO>

Send request on an open connection with a byte array body

(JavaScript docs)

pub fn abort(&self)

Aborts the request if it has already been sent. When a request is aborted, its ready_state is changed to Done and the status code is set to Unsent.

(JavaScript docs)

Trait Implementations

impl JsSerialize for XmlHttpRequest

impl TryFrom<EventTarget> for XmlHttpRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: EventTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<XmlHttpRequest> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: XmlHttpRequest) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for XmlHttpRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for XmlHttpRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for XmlHttpRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for XmlHttpRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for XmlHttpRequest

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl ReferenceType for XmlHttpRequest

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl IEventTarget for XmlHttpRequest

fn add_event_listener<T, F>(&self, listener: F) -> EventListenerHandle where
    T: ConcreteEvent,
    F: FnMut(T) + 'static, 

Adds given event handler to the list of event listeners for the specified EventTarget on which it's called.

fn dispatch_event<T: IEvent>(&self, event: &T) -> Result<bool, TODO>

Dispatches an Event at this EventTarget, invoking the affected event listeners in the appropriate order.

impl AsRef<Reference> for XmlHttpRequest

fn as_ref(&self) -> &Reference

Performs the conversion.

impl From<XmlHttpRequest> for EventTarget

fn from(value: XmlHttpRequest) -> Self

Performs the conversion.

impl From<XmlHttpRequest> for Reference

fn from(value: XmlHttpRequest) -> Self

Performs the conversion.

impl Clone for XmlHttpRequest

fn clone(&self) -> XmlHttpRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for XmlHttpRequest

impl PartialEq<XmlHttpRequest> for XmlHttpRequest

fn eq(&self, other: &XmlHttpRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &XmlHttpRequest) -> bool

This method tests for !=.

impl Debug for XmlHttpRequest

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

Formats the value using the given formatter.