Struct ArcRwLockStream

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

Implementations

impl ArcRwLockStream

pub fn from(arc_rw_lock_stream: Arc<RwLock<TcpStream>>) -> ArcRwLockStream

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) -> ArcRwLockStream

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 get_read_lock(&self) -> RwLockReadGuard<'_, TcpStream>

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 get_write_lock(&self) -> RwLockWriteGuard<'_, TcpStream>

Returns a mutable reference to the inner TcpStream.

This method acquires a write lock on the underlying stream, allowing exclusive access for writing operations while preventing any concurrent access.

Returns

Returns a write guard that provides exclusive access to the TCP stream

pub async fn send(&self, data: &Vec<u8>) -> Result<(), Error>

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( &self, body: &Vec<u8>, is_websocket: bool, ) -> Result<(), Error>

Sends the HTTP 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 flush(&self) -> Result<(), Error>

Flush the TCP stream.

• Returns: A ResponseResult indicating success or failure.

pub async fn close(&self) -> Result<(), Error>

Closes the stream after sending the response.

This function is responsible for:

• Building the response using the build() method.
• Setting the response using the set_response() method.
• Shutting down the write half of the TCP stream to indicate no more data will be sent.

Returns

• ResponseResult: The result of the operation, indicating whether the closure was successful or if an error occurred.

Trait Implementations

impl Clone for ArcRwLockStream

fn clone(&self) -> ArcRwLockStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArcRwLockStream

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

Formats the value using the given formatter.