Struct Abortable

pub struct Abortable(/* private fields */);

Abortable trigger wraps an Arc<AtomicBool>, which can be cloned to signal task terminating using an atomic bool.

let abortable = Abortable::default();
let result = my_task(abortable).await?;
// ... elsewhere
abortable.abort();

@category General

Implementations

impl Abortable

pub fn new() -> Abortable

pub fn is_aborted(&self) -> bool

pub fn abort(&self)

pub fn check(&self) -> Result<(), Aborted>

pub fn reset(&self)

Trait Implementations

impl Clone for Abortable

fn clone(&self) -> Abortable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Abortable

fn default() -> Abortable

Returns the “default value” for a type.

impl From<Abortable> for JsValue

fn from(value: Abortable) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Abortable

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Abortable

Recover a Self from Self::Abi.

impl IntoWasmAbi for Abortable

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for Abortable

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Abortable>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Abortable as LongRefFromWasmAbi>::Abi, ) -> <Abortable as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Abortable

fn is_none(abi: &<Abortable 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 OptionIntoWasmAbi for Abortable

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

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

impl RefFromWasmAbi for Abortable

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Abortable>

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

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

impl RefMutFromWasmAbi for Abortable

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Abortable>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <Abortable as RefMutFromWasmAbi>::Abi, ) -> <Abortable as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFrom<&JsValue> for Abortable

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from( value: &JsValue, ) -> Result<Abortable, <Abortable as TryFrom<&JsValue>>::Error>

Performs the conversion.

impl TryFromJsValue for Abortable

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<Abortable, <Abortable as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for Abortable

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

unsafe fn vector_from_abi( js: <Abortable as VectorFromWasmAbi>::Abi, ) -> Box<[Abortable]>

impl VectorIntoWasmAbi for Abortable

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

fn vector_into_abi( vector: Box<[Abortable]>, ) -> <Abortable as VectorIntoWasmAbi>::Abi