Struct Context

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

Context structure.

Wraps InnerContext providing thread-safe shared access.

Implementations

impl Context

Provides thread-safe access and manipulation of the context.

pub async fn get_read_lock(&self) -> RwLockReadContext<'_>

Gets a read lock for the inner context.

Arguments

• &self - A reference to the Context.

Returns

• RwLockReadContext - A read guard for the inner context.

pub async fn get_write_lock(&self) -> RwLockWriteContext<'_>

Gets a write lock for the inner context.

Arguments

• &self - A reference to the Context.

Returns

• RwLockWriteContext - A write guard for the inner context.

pub async fn get(&self) -> InnerContext

Gets a clone of the inner context.

Arguments

• &self - A reference to the Context.

Returns

• InnerContext - A cloned inner context.

pub async fn get_stream(&self) -> OptionArcRwLockStream

Gets the stream from the inner context.

Arguments

• &self - A reference to the Context.

Returns

• OptionArcRwLockStream - The optional stream.

pub async fn get_request(&self) -> Request

Gets the request from the inner context.

Arguments

• &self - A reference to the Context.

Returns

• Request - The request object.

pub async fn get_response(&self) -> Response

Gets the response from the inner context.

Arguments

• &self - A reference to the Context.

Returns

• Response - The response object.

pub async fn get_socket_addr(&self) -> OptionSocketAddr

Gets the socket address from the stream.

Arguments

• &self - A reference to the Context.

Returns

• OptionSocketAddr - The optional socket address.

pub async fn get_socket_addr_or_default(&self) -> SocketAddr

Gets the socket address or a default if none is available.

Arguments

• &self - A reference to the Context.

Returns

• SocketAddr - The socket address or the default socket address.

pub async fn get_socket_addr_string(&self) -> Option<String>

Gets the socket address as a string.

Arguments

• &self - A reference to the Context.

Returns

• Option<String> - The socket address as a string, if available.

pub async fn get_socket_addr_or_default_string(&self) -> String

Gets the socket address as a string, or a default string if none is available.

Arguments

• &self - A reference to the Context.

Returns

• String - The socket address as a string, or the default socket address string.

pub async fn get_socket_host(&self) -> OptionSocketHost

Gets the socket host from the socket address.

Arguments

• &self - A reference to the Context.

Returns

• OptionSocketHost - The optional socket host.

pub async fn get_socket_port(&self) -> OptionSocketPort

Gets the socket port from the socket address.

Arguments

• &self - A reference to the Context.

Returns

• OptionSocketPort - The optional socket port.

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

Sends data through the stream.

Arguments

• &self - A reference to the Context.
• data - The data to send, which can be converted into ResponseData.

Returns

• ResponseResult - Ok(()) on success, or an error if the stream is not found or sending fails.

pub async fn close(&self) -> ResponseResult

Closes the stream.

Arguments

• &self - A reference to the Context.

Returns

• ResponseResult - Ok(()) on success, or an error if the stream is not found or closing fails.

pub async fn flush(&self) -> ResponseResult

Flushes the stream.

Arguments

• &self - A reference to the Context.

Returns

• ResponseResult - Ok(()) on success, or an error if the stream is not found or flushing fails.

pub async fn set_data_value<T: Any + Send + Sync + Clone>( &self, key: &str, value: &T, ) -> &Self

Sets a data value in the context’s data map.

Arguments

• &self - A reference to the Context.
• key - The key for the data.
• value - The value to set, which must be cloneable and thread-safe.

Returns

• &Self - A reference to the Context.

pub async fn get_data_value<T: Any + Send + Sync + Clone>( &self, key: &str, ) -> Option<T>

Gets a data value from the context’s data map.

Arguments

• &self - A reference to the Context.
• key - The key for the data.

Returns

• Option<T> - The data value if found and successfully downcasted, otherwise None.

pub async fn remove_data_value(&self, key: &str) -> &Self

Removes a data value from the context’s data map.

Arguments

• &self - A reference to the Context.
• key - The key of the data to remove.

Returns

• &Self - A reference to the Context.

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

Clears all data from the context’s data map.

Arguments

• &self - A reference to the Context.

Returns

• &Self - A reference to the Context.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.