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

source

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.

source

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

Returns serialized IP address of the peer connection.

See HttpRequest::peer_addr for more details.

source

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
source

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§

source§

impl Clone for ConnectionInfo

source§

fn clone(&self) -> ConnectionInfo

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ConnectionInfo

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ConnectionInfo

source§

fn default() -> ConnectionInfo

Returns the “default value” for a type. Read more
source§

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. Read more
source§

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.
source§

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

Create a Self from request head asynchronously. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more