Struct libp2p::wasm_ext::ffi::Connection

#[repr(transparent)]
pub struct Connection { /* fields omitted */ }

Type of the object that represents an open connection with a remote.

Methods

impl Connection

pub fn read(&self) -> Iterator

Returns a Readable​Stream​ that .

impl Connection

pub fn write(&self, data: &[u8]) -> Result<Promise, JsValue>

Writes data to the connection. Returns a Promise that resolves when the connection is ready for writing again.

If the Promise returns an error, the writing side of the connection is considered unrecoverable and the connection should be closed as soon as possible.

Guaranteed to only be called after the previous write promise has resolved.

impl Connection

pub fn shutdown(&self) -> Result<(), JsValue>

Shuts down the writing side of the connection. After this has been called, the write method will no longer be called.

impl Connection

pub fn close(&self)

Closes the connection. No other method will be called on this connection anymore.

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_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Connection> for Connection

fn as_ref(&self) -> &Connection

Performs the conversion.

impl AsRef<JsValue> for Connection

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl Deref for Connection

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<Connection> for JsValue

fn from(obj: Connection) -> JsValue

Performs the conversion.

impl From<JsValue> for Connection

fn from(obj: JsValue) -> Connection

Performs the conversion.

impl FromWasmAbi for Connection

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: <Connection as FromWasmAbi>::Abi) -> Connection

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Connection

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

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

fn into_abi(self) -> <&'a Connection as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for Connection

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <Connection as IntoWasmAbi>::Abi

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

impl JsCast for Connection

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

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

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

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 OptionFromWasmAbi for Connection

fn is_none(abi: &<Connection as FromWasmAbi>::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 Connection

fn none() -> <&'a Connection as IntoWasmAbi>::Abi

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

impl OptionIntoWasmAbi for Connection

fn none() -> <Connection as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for Connection

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Connection>

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: <Connection as RefFromWasmAbi>::Abi
) -> <Connection as RefFromWasmAbi>::Anchor

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