Struct Context 

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

The main application context, providing thread-safe access to request and response data.

This is a wrapper around ContextData that uses an Arc<RwLock<>> to allow for shared, mutable access across asynchronous tasks.

Implementations

impl Context

Implementation of methods for Context.

pub fn new( socket: &ArcRwLockUdpSocket, request: &Request, client_addr: SocketAddr, ) -> Self

Creates a new Context with the given socket, request, and client address.

Arguments

• socket - The network socket.
• request - The request data.
• client_addr - The client’s socket address.

Returns

• Self - A new Context instance.

pub async fn get_aborted(&self) -> bool

Checks if the context has been marked as aborted.

Returns

• bool - True if the context is aborted, otherwise false.

pub async fn set_aborted(&self, aborted: bool)

Sets the aborted flag for the context.

Arguments

• aborted - The aborted state to set.

pub async fn aborted(&self)

Marks the context as aborted.

pub async fn cancel_aborted(&self)

Cancels the aborted state of the context.

pub async fn try_get_socket(&self) -> Option<ArcRwLockUdpSocket>

Retrieves the underlying network socket, if available.

Returns

• Option<ArcRwLockUdpSocket> - The thread-safe, shareable network socket if it exists.

pub async fn get_socket(&self) -> ArcRwLockUdpSocket

Retrieves the underlying network socket.

Returns

• ArcRwLockUdpSocket - The thread-safe, shareable network socket.

Panics

• If the network socket is not found.

pub async fn get_request(&self) -> Request

Retrieves the current request.

Returns

• Request - A clone of the current request.

pub async fn get_response(&self) -> Response

Retrieves the current response.

Returns

• Response - A clone of the current response.

pub async fn try_get_client_addr(&self) -> Option<SocketAddr>

Retrieves the client address, if available.

Returns

• Option<SocketAddr> - The client address if present.

pub async fn get_client_addr(&self) -> SocketAddr

Retrieves the client address.

Returns

• SocketAddr - The client address.

Panics

• If the client address is not found.

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

Retrieves the client address as a string.

Returns

• Option<String> - The string representation of the client address if available.

pub async fn try_get_client_host(&self) -> Option<IpAddr>

Retrieves the client host IP address.

Returns

• Option<IpAddr> - The client IP address if available.

pub async fn try_get_client_port(&self) -> Option<u16>

Retrieves the client port number.

Returns

• Option<u16> - The client port number if available.

pub async fn set_attribute<K, V>(&self, key: K, value: V) -> &Self

where K: AsRef<str>, V: AnySendSyncClone,

Sets an attribute in the context.

Arguments

• K - The key of the attribute to set.
• V - The value of the attribute.

Returns

• &Self - A reference to the modified context.

pub async fn try_get_attribute<V, K>(&self, key: K) -> Option<V>

where V: AnySendSyncClone, K: AsRef<str>,

Attempts to retrieve a specific attribute by its key.

Arguments

• K - The key of the attribute to retrieve.

Returns

• Option<V> - The attribute value if it exists and can be cast to the specified type.

pub async fn get_attribute<V, K>(&self, key: K) -> V

where V: AnySendSyncClone, K: AsRef<str>,

Retrieves a specific attribute by its key.

Arguments

• K - The key of the attribute to retrieve.

Returns

• V - The attribute value.

Panics

• If the attribute is not found.

pub async fn remove_attribute<K>(&self, key: K) -> &Self

where K: AsRef<str>,

Removes an attribute from the context.

Arguments

• K - The key of the attribute to remove.

Returns

• &Self - A reference to the modified context.

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

Clears all attributes from the context.

Returns

• &Self - A reference to the modified context.

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

where T: Into<ResponseData>,

Sends a response to the client.

Arguments

• Into<ResponseData> - The response data.

Returns

• ResponseResult - Result of the send operation.

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.

impl Default for Context

Provides a default implementation for Context.

fn default() -> Self

Creates a default Context wrapping default ContextData.

Returns

• Self - A new instance with default values.