Struct actix_web::dev::ConnectionInfo
source · pub struct ConnectionInfo { /* private fields */ }
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§
source§impl ConnectionInfo
impl ConnectionInfo
sourcepub fn realip_remote_addr(&self) -> Option<&str>
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
headerX-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.
sourcepub fn peer_addr(&self) -> Option<&str>
pub fn peer_addr(&self) -> Option<&str>
Returns serialized IP address of the peer connection.
See HttpRequest::peer_addr
for more details.
Trait Implementations§
source§impl Clone for ConnectionInfo
impl Clone for ConnectionInfo
source§fn clone(&self) -> ConnectionInfo
fn clone(&self) -> ConnectionInfo
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ConnectionInfo
impl Debug for ConnectionInfo
source§impl Default for ConnectionInfo
impl Default for ConnectionInfo
source§fn default() -> ConnectionInfo
fn default() -> ConnectionInfo
source§impl FromRequest for ConnectionInfo
impl FromRequest for ConnectionInfo
§type Error = Infallible
type Error = Infallible
§type Future = Ready<Result<ConnectionInfo, <ConnectionInfo as FromRequest>::Error>>
type Future = Ready<Result<ConnectionInfo, <ConnectionInfo as FromRequest>::Error>>
Self
. Read moresource§fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
Self
from request parts asynchronously.Auto Trait Implementations§
impl Freeze for ConnectionInfo
impl RefUnwindSafe for ConnectionInfo
impl Send for ConnectionInfo
impl Sync for ConnectionInfo
impl Unpin for ConnectionInfo
impl UnwindSafe for ConnectionInfo
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)