Struct uiuifree_actix_web_util::dev::ConnectionInfo

pub struct ConnectionInfo { /* private fields */ }

HTTP connection information.

ConnectionInfo implements FromRequest and can be extracted in handlers.

Examples

use actix_web::dev::ConnectionInfo;

async fn handler(conn: ConnectionInfo) -> impl Responder {
    match conn.host() {
        "actix.rs" => HttpResponse::Ok().body("Welcome!"),
        "admin.actix.rs" => HttpResponse::Ok().body("Admin portal."),
        _ => HttpResponse::NotFound().finish()
    }
}

Implementation Notes

Parses Forwarded header information according to RFC 7239 but does not try to interpret the values for each property. As such, the getter methods on ConnectionInfo return strings instead of IP addresses or other types to acknowledge that they may be obfuscated or unknown.

If the older, related headers are also present (eg. X-Forwarded-For), then Forwarded is preferred.

Implementations

impl ConnectionInfo

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

Real IP (remote address) of client that initiated request.

The address is resolved through the following, in order:

• Forwarded header
• X-Forwarded-For header
• peer address of opened socket (same as remote_addr)

Security

Do not use this function for security purposes unless you can be sure that the Forwarded and X-Forwarded-For headers cannot be spoofed by the client. If you are running without a proxy then obtaining the peer address would be more appropriate.

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

Returns serialized IP address of the peer connection.

See HttpRequest::peer_addr for more details.

pub fn host(&self) -> &str

Hostname of the request.

Hostname is resolved through the following, in order:

• Forwarded header
• X-Forwarded-Host header
• Host header
• request target / URI
• configured server hostname

pub fn scheme(&self) -> &str

Scheme of the request.

Scheme is resolved through the following, in order:

• Forwarded header
• X-Forwarded-Proto header
• request target / URI

Trait Implementations

impl Clone for ConnectionInfo

fn clone(&self) -> ConnectionInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionInfo

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

Formats the value using the given formatter.

impl Default for ConnectionInfo

fn default() -> ConnectionInfo

Returns the “default value” for a type.

impl FromRequest for ConnectionInfo

type Error = Infallible

The associated error which can be returned.

type Future = Ready<Result<ConnectionInfo, <ConnectionInfo as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request(
    req: &HttpRequest,
    &mut Payload<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>
) -> <ConnectionInfo as FromRequest>::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.