Struct LibfwClient 

pub struct LibfwClient { /* private fields */ }

WASM engine facade. Construct via new LibfwClient(options).

Implementations

impl LibfwClient

pub fn new(opts: JsValue) -> LibfwClient

Create an engine. options may include: { concurrency, uploadWindow, downloadWindow, downloadChunkSize, compress, chunkSize, maxRetries, baseRetryDelayMs, maxRetryDelayMs, timeoutMs }.

pub fn set_callbacks(&self, callbacks: JsValue)

Install the JS callbacks object (required before any transfer).

pub fn download_folder( &self, base_url: &str, token: &str, dir_path: &str, ) -> Promise

Download every file under the virtual dirPath (empty = root).

Resolves with the number of bytes written.

pub fn download_file( &self, base_url: &str, token: &str, file_path: &str, ) -> Promise

Download a single file at file_path into the chosen local directory.

Resolves with the number of bytes written.

pub fn upload(&self, base_url: &str, token: &str) -> Promise

Upload the files reported by the JS getFileList callback.

Resolves with the number of bytes uploaded.

pub fn pause(&self)

Pause the active transfer (state → paused).

pub fn resume(&self)

Resume a paused transfer.

pub fn cancel(&self)

Cancel the active transfer (state → failed).

pub fn state(&self) -> String

Current state: idle | downloading | uploading | paused | completed | failed.

pub fn progress(&self) -> f64

Progress in [0, 1].

pub fn done_bytes(&self) -> f64

Bytes transferred so far.

pub fn total_bytes(&self) -> f64

Total bytes to transfer.

pub fn has_callbacks(&self) -> bool

Whether callbacks have been installed.

Trait Implementations

impl From<LibfwClient> for JsValue

fn from(value: LibfwClient) -> Self

Converts to this type from the input type.

impl FromWasmAbi for LibfwClient

type Abi = WasmPtr<WasmRefCell<LibfwClient>>

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 IntoWasmAbi for LibfwClient

type Abi = WasmPtr<WasmRefCell<LibfwClient>>

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 LongRefFromWasmAbi for LibfwClient

type Abi = WasmPtr<WasmRefCell<LibfwClient>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<LibfwClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for LibfwClient

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 OptionIntoWasmAbi for LibfwClient

fn none() -> Self::Abi

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

impl RefFromWasmAbi for LibfwClient

type Abi = WasmPtr<WasmRefCell<LibfwClient>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<LibfwClient>

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 RefMutFromWasmAbi for LibfwClient

type Abi = WasmPtr<WasmRefCell<LibfwClient>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<LibfwClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for LibfwClient

impl SupportsInstanceProperty for LibfwClient

impl SupportsStaticProperty for LibfwClient

impl TryFromJsValue for LibfwClient

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for LibfwClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[LibfwClient]>

impl VectorIntoWasmAbi for LibfwClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[LibfwClient]>) -> Self::Abi

impl WasmDescribe for LibfwClient

fn describe()

impl WasmDescribeVector for LibfwClient

fn describe_vector()