Struct CancelHandle

pub struct CancelHandle { /* private fields */ }

Implementations

impl CancelHandle

pub fn new() -> Self

pub fn new_rc() -> Rc<Self>

pub fn cancel(&self)

Cancel all cancelable futures that are bound to this handle. Note that this method does not require a mutable reference to the CancelHandle.

pub fn is_canceled(&self) -> bool

Trait Implementations

impl Debug for CancelHandle

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

Formats the value using the given formatter.

impl Default for CancelHandle

fn default() -> CancelHandle

Returns the “default value” for a type.

impl Resource for CancelHandle

fn name(&self) -> Cow<'_, str>

Returns a string representation of the resource which is made available to JavaScript code through op_resources. The default implementation returns the Rust type name, but specific resource types may override this trait method.

fn close(self: Rc<Self>)

Resources may implement the close() trait method if they need to do resource specific clean-ups, such as cancelling pending futures, after a resource has been removed from the resource table.

fn read(self: Rc<Self>, limit: usize) -> AsyncResult<BufView>

Read a single chunk of data from the resource. This operation returns a BufView that represents the data that was read. If a zero length buffer is returned, it indicates that the resource has reached EOF.

fn read_byob( self: Rc<Self>, buf: BufMutView, ) -> AsyncResult<(usize, BufMutView)>

Read a single chunk of data from the resource into the provided BufMutView.

fn write_error(self: Rc<Self>, _error: Error) -> AsyncResult<()>

Write an error state to this resource, if the resource supports it.

fn write(self: Rc<Self>, buf: BufView) -> AsyncResult<WriteOutcome>

Write a single chunk of data to the resource. The operation may not be able to write the entire chunk, in which case it should return the number of bytes written. Additionally it should return the BufView that was passed in.

fn write_all(self: Rc<Self>, view: BufView) -> AsyncResult<()>

Write an entire chunk of data to the resource. Unlike write(), this will ensure the entire chunk is written. If the operation is not able to write the entire chunk, an error is to be returned.

fn read_byob_sync(self: Rc<Self>, data: &mut [u8]) -> Result<usize, Error>

The same as read_byob(), but synchronous.

fn write_sync(self: Rc<Self>, data: &[u8]) -> Result<usize, Error>

The same as write(), but synchronous.

fn shutdown(self: Rc<Self>) -> AsyncResult<()>

The shutdown method can be used to asynchronously close the resource. It is not automatically called when the resource is dropped or closed.

fn backing_handle(self: Rc<Self>) -> Option<ResourceHandle>

Resources backed by a file descriptor or socket handle can let ops know to allow for low-level optimizations.

fn backing_fd(self: Rc<Self>) -> Option<ResourceHandleFd>

👎Deprecated: Use backing_handle

Resources backed by a file descriptor can let ops know to allow for low-level optimizations.

fn size_hint(&self) -> (u64, Option<u64>)