Struct deno_websocket::WsStreamResource
source · pub struct WsStreamResource {
pub stream: WebSocketStreamType,
pub cancel: CancelHandle,
}
Fields
stream: WebSocketStreamType
cancel: CancelHandle
Trait Implementations
sourceimpl Resource for WsStreamResource
impl Resource for WsStreamResource
sourcefn name(&self) -> Cow<'_, str>
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. Read moresourcefn read(
self: Rc<Self>,
limit: usize
) -> Pin<Box<dyn Future<Output = Result<BufView, Error>> + 'static, Global>>
fn read(
self: Rc<Self>,
limit: usize
) -> Pin<Box<dyn Future<Output = Result<BufView, Error>> + 'static, Global>>
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. Read moresourcefn read_byob(
self: Rc<Self>,
buf: BufMutView
) -> Pin<Box<dyn Future<Output = Result<(usize, BufMutView), Error>> + 'static, Global>>
fn read_byob(
self: Rc<Self>,
buf: BufMutView
) -> Pin<Box<dyn Future<Output = Result<(usize, BufMutView), Error>> + 'static, Global>>
Read a single chunk of data from the resource into the provided
BufMutView
. Read moresourcefn write(
self: Rc<Self>,
buf: BufView
) -> Pin<Box<dyn Future<Output = Result<WriteOutcome, Error>> + 'static, Global>>
fn write(
self: Rc<Self>,
buf: BufView
) -> Pin<Box<dyn Future<Output = Result<WriteOutcome, Error>> + 'static, Global>>
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. Read moresourcefn write_all(
self: Rc<Self>,
view: BufView
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static, Global>>
fn write_all(
self: Rc<Self>,
view: BufView
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static, Global>>
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. Read moresourcefn shutdown(
self: Rc<Self>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static, Global>>
fn shutdown(
self: Rc<Self>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static, Global>>
The shutdown method can be used to asynchronously close the resource. It
is not automatically called when the resource is dropped or closed. Read more
sourcefn close(self: Rc<Self>)
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. Read moresourcefn backing_fd(self: Rc<Self>) -> Option<i32>
fn backing_fd(self: Rc<Self>) -> Option<i32>
Resources backed by a file descriptor can let ops know to allow for
low-level optimizations. Read more
fn size_hint(&self) -> (u64, Option<u64>)
Auto Trait Implementations
impl !RefUnwindSafe for WsStreamResource
impl !Send for WsStreamResource
impl !Sync for WsStreamResource
impl !Unpin for WsStreamResource
impl !UnwindSafe for WsStreamResource
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more