Struct XmlHttpRequest

Source
pub struct XmlHttpRequest(/* private fields */);
Expand description

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)

Implementations§

Source§

impl XmlHttpRequest

Source

pub fn new() -> XmlHttpRequest

Creates new XmlHttpRequest.

Source

pub fn ready_state(&self) -> XhrReadyState

Returns the current state of the request as a XhrReadyState.

(JavaScript docs)

Source

pub fn response_type(&self) -> XhrResponseType

Returns the type of the request as a XhrResponseType

(JavaScript docs)

Source

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

Set the type that the XmlHttpRequest should return

(JavaScript docs)

Source

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)

Source

pub fn raw_response(&self) -> Value

Returns the object representing the response

(JavaScript docs)

Source

pub fn status(&self) -> u16

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

(JavaScript docs)

Source

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)

Source

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)

Source

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)

Source

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

Send request on an open connection with no data

(JavaScript docs)

Source

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

Send request on an open connection with string body

(JavaScript docs)

Source

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

Send request on an open connection with a byte array body

(JavaScript docs)

Source

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§

Source§

impl AsRef<Reference> for XmlHttpRequest

Source§

fn as_ref(&self) -> &Reference

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for XmlHttpRequest

Source§

fn clone(&self) -> XmlHttpRequest

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for XmlHttpRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<XmlHttpRequest> for EventTarget

Source§

fn from(value: XmlHttpRequest) -> Self

Converts to this type from the input type.
Source§

impl From<XmlHttpRequest> for Reference

Source§

fn from(value: XmlHttpRequest) -> Self

Converts to this type from the input type.
Source§

impl IEventTarget for XmlHttpRequest

Source§

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. Read more
Source§

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. Read more
Source§

impl InstanceOf for XmlHttpRequest

Source§

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.
Source§

impl PartialEq for XmlHttpRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl ReferenceType for XmlHttpRequest

Source§

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!
Source§

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

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<EventTarget> for XmlHttpRequest

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Reference> for XmlHttpRequest

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Value> for XmlHttpRequest

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<XmlHttpRequest> for Reference

Source§

type Error = Void

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Eq for XmlHttpRequest

Source§

impl JsSerialize for XmlHttpRequest

Source§

impl StructuralPartialEq for XmlHttpRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.