Struct deno_websocket::ServerWebSocket
source · pub struct ServerWebSocket { /* private fields */ }
Expand description
To avoid locks, we keep as much as we can inside of Cell
s.
Trait Implementations§
source§impl Resource for ServerWebSocket
impl Resource for ServerWebSocket
source§fn 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.source§fn read(
self: Rc<Self>,
limit: usize
) -> Pin<Box<dyn Future<Output = Result<BufView, Error>>>>
fn read( self: Rc<Self>, limit: usize ) -> Pin<Box<dyn Future<Output = Result<BufView, Error>>>>
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 moresource§fn read_byob(
self: Rc<Self>,
buf: BufMutView
) -> Pin<Box<dyn Future<Output = Result<(usize, BufMutView), Error>>>>
fn read_byob( self: Rc<Self>, buf: BufMutView ) -> Pin<Box<dyn Future<Output = Result<(usize, BufMutView), Error>>>>
Read a single chunk of data from the resource into the provided
BufMutView
. Read moresource§fn write_error(
self: Rc<Self>,
_error: Error
) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
fn write_error( self: Rc<Self>, _error: Error ) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
Write an error state to this resource, if the resource supports it.
source§fn write(
self: Rc<Self>,
buf: BufView
) -> Pin<Box<dyn Future<Output = Result<WriteOutcome, Error>>>>
fn write( self: Rc<Self>, buf: BufView ) -> Pin<Box<dyn Future<Output = Result<WriteOutcome, Error>>>>
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 moresource§fn write_all(
self: Rc<Self>,
view: BufView
) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
fn write_all( self: Rc<Self>, view: BufView ) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
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 moresource§fn read_byob_sync(self: Rc<Self>, data: &mut [u8]) -> Result<usize, Error>
fn read_byob_sync(self: Rc<Self>, data: &mut [u8]) -> Result<usize, Error>
The same as
read_byob()
, but synchronous.source§fn write_sync(self: Rc<Self>, data: &[u8]) -> Result<usize, Error>
fn write_sync(self: Rc<Self>, data: &[u8]) -> Result<usize, Error>
The same as
write()
, but synchronous.source§fn shutdown(self: Rc<Self>) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
fn shutdown(self: Rc<Self>) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>
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
source§fn 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.source§fn backing_handle(self: Rc<Self>) -> Option<ResourceHandle>
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.
source§fn backing_fd(self: Rc<Self>) -> Option<i32>
fn backing_fd(self: Rc<Self>) -> Option<i32>
👎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>)
Auto Trait Implementations§
impl !RefUnwindSafe for ServerWebSocket
impl Send for ServerWebSocket
impl !Sync for ServerWebSocket
impl Unpin for ServerWebSocket
impl !UnwindSafe for ServerWebSocket
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more