Struct worker::Cf

pub struct Cf { /* private fields */ }

In addition to the methods on the Request struct, the Cf struct on an inbound Request contains information about the request provided by Cloudflare’s edge.

Details

Implementations

impl Cf

pub fn colo(&self) -> String

The three-letter airport code (e.g. ATX, LUX) representing the colocation which processed the request

pub fn asn(&self) -> u32

The Autonomous System Number (ASN) of the request, e.g. 395747

pub fn country(&self) -> Option<String>

The two-letter country code of origin for the request. This is the same value as that provided in the CF-IPCountry header, e.g. "US"

pub fn http_protocol(&self) -> String

The HTTP Protocol (e.g. “HTTP/2”) used by the request

pub fn request_priority(&self) -> Option<RequestPriority>

The browser-requested prioritization information in the request object,

See this blog post for details.

pub fn tls_cipher(&self) -> String

The cipher for the connection to Cloudflare, e.g. “AEAD-AES128-GCM-SHA256”.

pub fn tls_client_auth(&self) -> Option<TlsClientAuth>

Information about the client’s authorization. Only set when using Cloudflare Access or API Shield.

pub fn tls_version(&self) -> String

The TLS version of the connection to Cloudflare, e.g. TLSv1.3.

pub fn city(&self) -> Option<String>

City of the incoming request, e.g. “Austin”.

pub fn continent(&self) -> Option<String>

Continent of the incoming request, e.g. “NA”

pub fn coordinates(&self) -> Option<(f32, f32)>

Latitude and longitude of the incoming request, e.g. (30.27130, -97.74260)

pub fn postal_code(&self) -> Option<String>

Postal code of the incoming request, e.g. “78701”

pub fn metro_code(&self) -> Option<String>

Metro code (DMA) of the incoming request, e.g. “635”

pub fn region(&self) -> Option<String>

If known, the ISO 3166-2 name for the first level region associated with the IP address of the incoming request, e.g. “Texas”.

pub fn region_code(&self) -> Option<String>

If known, the ISO 3166-2 code for the first level region associated with the IP address of the incoming request, e.g. “TX”.

pub fn timezone(&self) -> impl TimeZone

Timezone of the incoming request

pub fn timezone_name(&self) -> String

Timezone name of the incoming request

pub fn is_eu_country(&self) -> bool

Whether the country of the incoming request is in the EU

Trait Implementations

impl Debug for Cf

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

Formats the value using the given formatter.

impl From<IncomingRequestCfProperties> for Cf

fn from(inner: IncomingRequestCfProperties) -> Self

Converts to this type from the input type.