Struct web_sys::WebTransport
source · pub struct WebTransport { /* private fields */ }
Expand description
The WebTransport
class.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
Implementations§
source§impl WebTransport
impl WebTransport
sourcepub fn ready(&self) -> Promise
pub fn ready(&self) -> Promise
Getter for the ready
field of this object.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn reliability(&self) -> WebTransportReliabilityMode
pub fn reliability(&self) -> WebTransportReliabilityMode
Getter for the reliability
field of this object.
This API requires the following crate features to be activated: WebTransport
, WebTransportReliabilityMode
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn congestion_control(&self) -> WebTransportCongestionControl
pub fn congestion_control(&self) -> WebTransportCongestionControl
Getter for the congestionControl
field of this object.
This API requires the following crate features to be activated: WebTransport
, WebTransportCongestionControl
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn closed(&self) -> Promise
pub fn closed(&self) -> Promise
Getter for the closed
field of this object.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn draining(&self) -> Promise
pub fn draining(&self) -> Promise
Getter for the draining
field of this object.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn datagrams(&self) -> WebTransportDatagramDuplexStream
pub fn datagrams(&self) -> WebTransportDatagramDuplexStream
Getter for the datagrams
field of this object.
This API requires the following crate features to be activated: WebTransport
, WebTransportDatagramDuplexStream
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn incoming_bidirectional_streams(&self) -> ReadableStream
pub fn incoming_bidirectional_streams(&self) -> ReadableStream
Getter for the incomingBidirectionalStreams
field of this object.
This API requires the following crate features to be activated: ReadableStream
, WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn incoming_unidirectional_streams(&self) -> ReadableStream
pub fn incoming_unidirectional_streams(&self) -> ReadableStream
Getter for the incomingUnidirectionalStreams
field of this object.
This API requires the following crate features to be activated: ReadableStream
, WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn new(url: &str) -> Result<WebTransport, JsValue>
pub fn new(url: &str) -> Result<WebTransport, JsValue>
The new WebTransport(..)
constructor, creating a new instance of WebTransport
.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn new_with_options(
url: &str,
options: &WebTransportOptions,
) -> Result<WebTransport, JsValue>
pub fn new_with_options( url: &str, options: &WebTransportOptions, ) -> Result<WebTransport, JsValue>
The new WebTransport(..)
constructor, creating a new instance of WebTransport
.
This API requires the following crate features to be activated: WebTransport
, WebTransportOptions
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn close(&self)
pub fn close(&self)
The close()
method.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn close_with_close_info(&self, close_info: &WebTransportCloseInfo)
pub fn close_with_close_info(&self, close_info: &WebTransportCloseInfo)
The close()
method.
This API requires the following crate features to be activated: WebTransport
, WebTransportCloseInfo
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn create_bidirectional_stream(&self) -> Promise
pub fn create_bidirectional_stream(&self) -> Promise
The createBidirectionalStream()
method.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn create_bidirectional_stream_with_options(
&self,
options: &WebTransportSendStreamOptions,
) -> Promise
pub fn create_bidirectional_stream_with_options( &self, options: &WebTransportSendStreamOptions, ) -> Promise
The createBidirectionalStream()
method.
This API requires the following crate features to be activated: WebTransport
, WebTransportSendStreamOptions
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn create_unidirectional_stream(&self) -> Promise
pub fn create_unidirectional_stream(&self) -> Promise
The createUnidirectionalStream()
method.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn create_unidirectional_stream_with_options(
&self,
options: &WebTransportSendStreamOptions,
) -> Promise
pub fn create_unidirectional_stream_with_options( &self, options: &WebTransportSendStreamOptions, ) -> Promise
The createUnidirectionalStream()
method.
This API requires the following crate features to be activated: WebTransport
, WebTransportSendStreamOptions
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
source§impl WebTransport
impl WebTransport
sourcepub fn get_stats(&self) -> Promise
pub fn get_stats(&self) -> Promise
The getStats()
method.
This API requires the following crate features to be activated: WebTransport
This API is unstable and requires --cfg=web_sys_unstable_apis
to be activated, as
described in the wasm-bindgen
guide
Methods from Deref<Target = Object>§
sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object
constructor
function that created the instance object.
sourcepub fn has_own_property(&self, property: &JsValue) -> bool
pub fn has_own_property(&self, property: &JsValue) -> bool
The hasOwnProperty()
method returns a boolean indicating whether the
object has the specified property as its own property (as opposed to
inheriting it).
sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
sourcepub fn to_locale_string(&self) -> JsString
pub fn to_locale_string(&self) -> JsString
The toLocaleString()
method returns a string representing the object.
This method is meant to be overridden by derived objects for
locale-specific purposes.
sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString()
method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
Returns the f64
value of this JS value if it’s an instance of a
number.
If this JS value is not an instance of a number then this returns
None
.
sourcepub fn as_string(&self) -> Option<String>
pub fn as_string(&self) -> Option<String>
If this JS value is a string value, this function copies the JS string
value into Wasm linear memory, encoded as UTF-8, and returns it as a
Rust String
.
To avoid the copying and re-encoding, consider the
JsString::try_from()
function from js-sys
instead.
If this JS value is not an instance of a string or if it’s not valid
utf-8 then this returns None
.
§UTF-16 vs UTF-8
JavaScript strings in general are encoded as UTF-16, but Rust strings
are encoded as UTF-8. This can cause the Rust string to look a bit
different than the JS string sometimes. For more details see the
documentation about the str
type which contains a few
caveats about the encodings.
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
Returns the bool
value of this JS value if it’s an instance of a
boolean.
If this JS value is not an instance of a boolean then this returns
None
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsValue> for WebTransport
impl AsRef<JsValue> for WebTransport
source§impl AsRef<Object> for WebTransport
impl AsRef<Object> for WebTransport
source§impl AsRef<WebTransport> for WebTransport
impl AsRef<WebTransport> for WebTransport
source§fn as_ref(&self) -> &WebTransport
fn as_ref(&self) -> &WebTransport
source§impl Clone for WebTransport
impl Clone for WebTransport
source§fn clone(&self) -> WebTransport
fn clone(&self) -> WebTransport
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WebTransport
impl Debug for WebTransport
source§impl Deref for WebTransport
impl Deref for WebTransport
source§impl From<JsValue> for WebTransport
impl From<JsValue> for WebTransport
source§fn from(obj: JsValue) -> WebTransport
fn from(obj: JsValue) -> WebTransport
source§impl From<WebTransport> for JsValue
impl From<WebTransport> for JsValue
source§fn from(obj: WebTransport) -> JsValue
fn from(obj: WebTransport) -> JsValue
source§impl From<WebTransport> for Object
impl From<WebTransport> for Object
source§fn from(obj: WebTransport) -> Object
fn from(obj: WebTransport) -> Object
source§impl FromWasmAbi for WebTransport
impl FromWasmAbi for WebTransport
source§impl<'a> IntoWasmAbi for &'a WebTransport
impl<'a> IntoWasmAbi for &'a WebTransport
source§impl IntoWasmAbi for WebTransport
impl IntoWasmAbi for WebTransport
source§impl JsCast for WebTransport
impl JsCast for WebTransport
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for WebTransport
impl LongRefFromWasmAbi for WebTransport
source§type Anchor = WebTransport
type Anchor = WebTransport
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for WebTransport
impl OptionFromWasmAbi for WebTransport
source§impl<'a> OptionIntoWasmAbi for &'a WebTransport
impl<'a> OptionIntoWasmAbi for &'a WebTransport
source§impl OptionIntoWasmAbi for WebTransport
impl OptionIntoWasmAbi for WebTransport
source§impl PartialEq for WebTransport
impl PartialEq for WebTransport
source§impl RefFromWasmAbi for WebTransport
impl RefFromWasmAbi for WebTransport
source§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.source§type Anchor = ManuallyDrop<WebTransport>
type Anchor = ManuallyDrop<WebTransport>
Self
for the duration of the
invocation of the function that has an &Self
parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous.impl Eq for WebTransport
impl StructuralPartialEq for WebTransport
Auto Trait Implementations§
impl Freeze for WebTransport
impl RefUnwindSafe for WebTransport
impl !Send for WebTransport
impl !Sync for WebTransport
impl Unpin for WebTransport
impl UnwindSafe for WebTransport
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.