Struct ArcRwLockStream

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

A wrapper around Arc<RwLock<TcpStream>>.

ArcRwLockStream provides shared, thread-safe access to a TcpStream using an atomic reference counter (Arc) combined with a read-write lock (RwLock). It is primarily used to safely share the stream across asynchronous tasks.

Fields

• 0: The inner Arc<RwLock<TcpStream>> stream.

Implementations

impl ArcRwLockStream

pub fn from(arc_rw_lock_stream: ArcRwLock<TcpStream>) -> Self

Creates a new ArcRwLockStream from an Arc<RwLock<TcpStream>>.

Parameters

• arc_rw_lock_stream: An Arc<RwLock<TcpStream>> that will be wrapped in the new ArcRwLockStream

Returns

Returns a new ArcRwLockStream instance containing the provided stream

pub fn from_stream(stream: TcpStream) -> Self

Creates a new ArcRwLockStream from a TcpStream.

Parameters

• stream: A TcpStream that will be wrapped in the new ArcRwLockStream

Returns

Returns a new ArcRwLockStream instance containing the provided stream wrapped in an Arc<RwLock<_>>

pub async fn read(&self) -> RwLockReadGuardTcpStream<'_>

Returns a reference to the inner TcpStream.

This method acquires a read lock on the underlying stream, allowing shared access to the TCP stream while preventing concurrent writes.

Returns

Returns a read guard that provides shared access to the TCP stream

pub async fn send(&self, data: &ResponseData) -> ResponseResult

Sends the HTTP response over a TCP stream.

Parameters

• data: Response data

Returns

• Ok: If the response is successfully sent.
• Err: If an error occurs during sending.

pub async fn send_body_conditional( &self, body: &ResponseBody, is_websocket: bool, ) -> ResponseResult

Sends the HTTP or HTTP websocket response body over a TCP stream.

Parameters

• body: Response body.
• is_websocket: Is websocket

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn send_body(&self, body: &ResponseBody) -> ResponseResult

Sends the HTTP response body over a TCP stream.

Parameters

• body: Response body.

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn send_ws_body(&self, body: &ResponseBody) -> ResponseResult

Sends the HTTP ws response body over a TCP stream.

Parameters

• body: Response body.

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn flush(&self) -> &Self

Flush the TCP stream.

• Returns: A ResponseResult indicating success or failure.

Trait Implementations

impl Clone for ArcRwLockStream

fn clone(&self) -> ArcRwLockStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArcRwLockStream

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

Formats the value using the given formatter.