Struct WebTransport

pub struct WebTransport { /* private fields */ }

The WebTransport interface.

https://w3c.github.io/webtransport/#webtransport

Implementations

impl WebTransport

pub fn new(url: &str) -> Result<WebTransport, DomException>

constructor(USVString url, optional WebTransportOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-webtransport

The new WebTransport(url) constructor, creating a new instance ofWebTransport.

impl WebTransport

pub fn new_with_options( url: &str, options: &WebTransportOptions, ) -> Result<WebTransport, DomException>

constructor(USVString url, optional WebTransportOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-webtransport

The new WebTransport(url, { ... }) constructor, creating a new instance of WebTransport.

impl WebTransport

pub async fn get_stats(&self) -> WebTransportConnectionStats

Promise<WebTransportConnectionStats> getStats();

https://w3c.github.io/webtransport/#dom-webtransport-getstats

Gathers stats for this WebTransport’s underlying connection and reports the result asynchronously.

impl WebTransport

pub async fn ready(&self) -> Result<(), DomException>

readonly attribute Promise<undefined> ready;

https://w3c.github.io/webtransport/#dom-webtransport-ready

A promise fulfilled when the associated WebTransport session gets established, or rejected if the establishment process failed.

impl WebTransport

pub fn reliability(&self) -> WebTransportReliabilityMode

readonly attribute WebTransportReliabilityMode reliability;

https://w3c.github.io/webtransport/#dom-webtransport-reliability

Whether connection supports unreliable (over UDP) transport or only reliable (over TCP fallback) transport. Returns “pending” until a connection has been established.

impl WebTransport

pub fn congestion_control(&self) -> WebTransportCongestionControl

readonly attribute WebTransportCongestionControl congestionControl;

https://w3c.github.io/webtransport/#dom-webtransport-congestioncontrol

The application’s preference, if requested in the constructor, and satisfied by the user agent, for a congestion control algorithm optimized for either throughput or low latency for sending on this connection. If a preference was requested but not satisfied, then the value is “default”.

impl WebTransport

pub fn anticipated_concurrent_incoming_unidirectional_streams( &self, ) -> Option<u16>

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingUnidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingunidirectionalstreams

Optionally lets an application specify the number of concurrently open incoming unidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingUnidirectionalStreams]] into consideration in its negotiations with the server.

impl WebTransport

pub fn set_option_anticipated_concurrent_incoming_unidirectional_streams( &self, val: Option<u16>, )

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingUnidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingunidirectionalstreams

Optionally lets an application specify the number of concurrently open incoming unidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingUnidirectionalStreams]] into consideration in its negotiations with the server.

impl WebTransport

pub fn anticipated_concurrent_incoming_bidirectional_streams( &self, ) -> Option<u16>

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingBidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingbidirectionalstreams

Optionally lets an application specify the number of concurrently open bidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingBidirectionalStreams]] into consideration in its negotiations with the server.

impl WebTransport

pub fn set_option_anticipated_concurrent_incoming_bidirectional_streams( &self, val: Option<u16>, )

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingBidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingbidirectionalstreams

Optionally lets an application specify the number of concurrently open bidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingBidirectionalStreams]] into consideration in its negotiations with the server.

impl WebTransport

pub async fn closed(&self) -> Result<WebTransportCloseInfo, DomException>

readonly attribute Promise<WebTransportCloseInfo> closed;

https://w3c.github.io/webtransport/#dom-webtransport-closed

A promise fulfilled when the associated WebTransport object is closed gracefully, or rejected when it is closed abruptly or failed on initialization.

impl WebTransport

pub async fn draining(&self)

readonly attribute Promise<undefined> draining;

https://w3c.github.io/webtransport/#dom-webtransport-draining

A promise fulfilled when the associated WebTransport session receives a DRAIN_WEBTRANSPORT_SESSION capsule or a GOAWAY frame.

impl WebTransport

pub fn close(&self)

undefined close(optional WebTransportCloseInfo closeInfo = {});

https://w3c.github.io/webtransport/#dom-webtransport-close

impl WebTransport

pub fn close_with_info(&self, close_info: &WebTransportCloseInfo)

undefined close(optional WebTransportCloseInfo closeInfo = {});

https://w3c.github.io/webtransport/#dom-webtransport-close

impl WebTransport

pub fn datagrams(&self) -> WebTransportDatagramDuplexStream

readonly attribute WebTransportDatagramDuplexStream datagrams;

https://w3c.github.io/webtransport/#dom-webtransport-datagrams

A single duplex stream for sending and receiving datagrams over this session.

impl WebTransport

pub async fn create_bidirectional_stream( &self, ) -> Result<WebTransportBidirectionalStream, DomException>

Promise<WebTransportBidirectionalStream> createBidirectionalStream(
 optional WebTransportSendStreamOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-createbidirectionalstream

Creates a WebTransportBidirectionalStream object for an outgoing bidirectional stream. Note that the mere creation of a stream is not immediately visible to the peer until it is used to send data.

impl WebTransport

pub async fn create_bidirectional_stream_with_options( &self, options: WebTransportSendStreamOptions, ) -> Result<WebTransportBidirectionalStream, DomException>

Promise<WebTransportBidirectionalStream> createBidirectionalStream(
 optional WebTransportSendStreamOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-createbidirectionalstream

Creates a WebTransportBidirectionalStream object for an outgoing bidirectional stream. Note that the mere creation of a stream is not immediately visible to the peer until it is used to send data.

impl WebTransport

pub fn incoming_bidirectional_streams(&self) -> ReadableStream

/* a ReadableStream of WebTransportBidirectionalStream objects */
readonly attribute ReadableStream incomingBidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-incomingbidirectionalstreams

Returns a ReadableStream of [WebTransportBidirectionalStreams] that have been received from the server.

impl WebTransport

pub async fn create_unidirectional_stream( &self, ) -> Result<WebTransportSendStream, DomException>

Promise<WebTransportSendStream> createUnidirectionalStream(
  optional WebTransportSendStreamOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-createunidirectionalstream

Creates a WebTransportSendStream for an outgoing unidirectional stream. Note that the mere creation of a stream is not immediately visible to the server until it is used to send data.

impl WebTransport

pub async fn create_unidirectional_stream_with_options( &self, options: WebTransportSendStreamOptions, ) -> Result<WebTransportSendStream, DomException>

Promise<WebTransportSendStream> createUnidirectionalStream(
  optional WebTransportSendStreamOptions options = {});

https://w3c.github.io/webtransport/#dom-webtransport-createunidirectionalstream

Creates a WebTransportSendStream for an outgoing unidirectional stream. Note that the mere creation of a stream is not immediately visible to the server until it is used to send data.

impl WebTransport

pub fn incoming_unidirectional_streams(&self) -> ReadableStream

/* a ReadableStream of WebTransportReceiveStream objects */
readonly attribute ReadableStream incomingUnidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-incomingunidirectionalstreams

A ReadableStream of unidirectional streams, each represented by a WebTransportReceiveStream, that have been received from the server.

impl WebTransport

pub fn create_send_group(&self) -> Result<WebTransportSendGroup, DomException>

WebTransportSendGroup createSendGroup();

https://w3c.github.io/webtransport/#dom-webtransport-createsendgroup

Creates a WebTransportSendGroup.

impl WebTransport

pub fn supports_reliable_only() -> bool

static readonly attribute boolean supportsReliableOnly;

https://w3c.github.io/webtransport/#dom-webtransport-supportsreliableonly

Returns true if the user agent supports WebTransport sessions over exclusively reliable connections, otherwise false.

impl WebTransport

pub fn set_anticipated_concurrent_incoming_unidirectional_streams( &self, val: u16, )

Set field to the given value.

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingUnidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingunidirectionalstreams

Optionally lets an application specify the number of concurrently open incoming unidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingUnidirectionalStreams]] into consideration in its negotiations with the server.

pub fn unset_anticipated_concurrent_incoming_unidirectional_streams(&self)

Unset field.

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingUnidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingunidirectionalstreams

Optionally lets an application specify the number of concurrently open incoming unidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingUnidirectionalStreams]] into consideration in its negotiations with the server.

pub fn set_anticipated_concurrent_incoming_bidirectional_streams( &self, val: u16, )

Set field to the given value.

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingBidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingbidirectionalstreams

Optionally lets an application specify the number of concurrently open bidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingBidirectionalStreams]] into consideration in its negotiations with the server.

pub fn unset_anticipated_concurrent_incoming_bidirectional_streams(&self)

Unset field.

[EnforceRange] attribute unsigned short? anticipatedConcurrentIncomingBidirectionalStreams;

https://w3c.github.io/webtransport/#dom-webtransport-anticipatedconcurrentincomingbidirectionalstreams

Optionally lets an application specify the number of concurrently open bidirectional streams it anticipates the server creating. If not null, the user agent SHOULD attempt to reduce future round-trips by taking [[AnticipatedConcurrentIncomingBidirectionalStreams]] into consideration in its negotiations with the server.

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

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).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

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.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

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.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS 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.

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.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for WebTransport

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for WebTransport

fn as_ref(&self) -> &Object

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

impl AsRef<WebTransport> for WebTransport

fn as_ref(&self) -> &WebTransport

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

impl Clone for WebTransport

fn clone(&self) -> WebTransport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebTransport

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

Formats the value using the given formatter.

impl Deref for WebTransport

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<JsValue> for WebTransport

fn from(obj: JsValue) -> WebTransport

Converts to this type from the input type.

impl From<WebTransport> for JsValue

fn from(obj: WebTransport) -> JsValue

Converts to this type from the input type.

impl From<WebTransport> for Object

fn from(obj: WebTransport) -> Object

Converts to this type from the input type.

impl FromWasmAbi for WebTransport

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a WebTransport

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for WebTransport

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for WebTransport

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for WebTransport

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = WebTransport

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for WebTransport

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a WebTransport

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for WebTransport

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for WebTransport

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RefFromWasmAbi for WebTransport

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<WebTransport>

The type that holds the reference to 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.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for WebTransport

fn describe()

impl Eq for WebTransport

impl StructuralPartialEq for WebTransport