Struct ClientInfo 

pub struct ClientInfo { /* private fields */ }

Client request context: IP address, user-agent, and fingerprint.

Implements FromRequestParts for automatic extraction in handlers. Requires ClientIpLayer for the ip field; if the layer is absent, ip will be None.

For non-HTTP contexts (background jobs, CLI tools), use the builder:

use modo::extractor::ClientInfo;

let info = ClientInfo::new()
    .ip("1.2.3.4")
    .user_agent("my-script/1.0");

Implementations

impl ClientInfo

pub fn new() -> Self

Create an empty ClientInfo with all fields set to None.

pub fn ip(self, ip: impl Into<String>) -> Self

Set the client IP address.

pub fn user_agent(self, ua: impl Into<String>) -> Self

Set the user-agent string.

pub fn fingerprint(self, fp: impl Into<String>) -> Self

Set the client fingerprint (from the x-fingerprint header).

pub fn ip_value(&self) -> Option<&str>

The client IP address, if available.

pub fn user_agent_value(&self) -> Option<&str>

The client user-agent string, if available.

pub fn fingerprint_value(&self) -> Option<&str>

The client fingerprint, if available.

Trait Implementations

impl Clone for ClientInfo

fn clone(&self) -> ClientInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientInfo

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

Formats the value using the given formatter.

impl Default for ClientInfo

fn default() -> ClientInfo

Returns the “default value” for a type.

impl<S: Send + Sync> FromRequestParts<S> for ClientInfo

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.