Struct ajars_actix_web::actix_web::dev::ConnectionInfo [−][src]
pub struct ConnectionInfo { /* fields omitted */ }
Expand description
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
Create ConnectionInfo instance for a request.
Scheme of the request.
Scheme is resolved through the following headers, in this order:
- Forwarded
- X-Forwarded-Proto
- Uri
Hostname of the request.
Hostname is resolved through the following headers, in this order:
- Forwarded
- X-Forwarded-Host
- Host
- Uri
- Server hostname
Remote address of the connection.
Get remote_addr address from socket address.
Real IP (remote address) of client that initiated request.
The address is resolved through the following headers, in this order:
- Forwarded
- X-Forwarded-For
- remote_addr name of opened socket
Security
Do not use this function for security purposes, unless you can ensure the Forwarded and
X-Forwarded-For headers cannot be spoofed by the client. If you want the client’s socket
address explicitly, use HttpRequest::peer_addr()
instead.
Trait Implementations
Returns the “default value” for a type. Read more
type Error = Infallible
type Error = Infallible
The associated error which can be returned.
type Future = Ready<Result<ConnectionInfo, <ConnectionInfo as FromRequest>::Error>>
type Future = Ready<Result<ConnectionInfo, <ConnectionInfo as FromRequest>::Error>>
Future that resolves to a Self.
pub fn from_request(
req: &HttpRequest,
&mut Payload<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>
) -> <ConnectionInfo as FromRequest>::Future
pub 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.
Create a Self from request head asynchronously. Read more
Auto Trait Implementations
impl RefUnwindSafe for ConnectionInfo
impl Send for ConnectionInfo
impl Sync for ConnectionInfo
impl Unpin for ConnectionInfo
impl UnwindSafe for ConnectionInfo
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self