Struct rama::proxy::ProxyFilter

pub struct ProxyFilter {
    pub id: Option<NonEmptyString>,
    pub pool_id: Option<Vec<StringFilter>>,
    pub continent: Option<Vec<StringFilter>>,
    pub country: Option<Vec<StringFilter>>,
    pub state: Option<Vec<StringFilter>>,
    pub city: Option<Vec<StringFilter>>,
    pub datacenter: Option<bool>,
    pub residential: Option<bool>,
    pub mobile: Option<bool>,
    pub carrier: Option<Vec<StringFilter>>,
    pub asn: Option<Vec<Asn>>,
}

Filter to select a specific kind of proxy.

If the id is specified the other fields are used as a validator to see if the only possible matching proxy matches these fields.

If the id is not specified, the other fields are used to select a random proxy from the pool.

Filters can be combined to make combinations with special meaning. E.g. datacenter:true, residential:true is essentially an ISP proxy.

Usage

• Use HeaderConfigLayer (rama-http) to have this proxy filter be given by the http Request headers, which will add the extracted and parsed ProxyFilter to the Context’s Extensions.
• Or extract yourself from the username/token validated in the ProxyAuthLayer (rama-http) to add it manually to the Context’s Extensions.

Fields

id: Option<NonEmptyString>

The ID of the proxy to select.

pool_id: Option<Vec<StringFilter>>

The ID of the pool from which to select the proxy.

continent: Option<Vec<StringFilter>>

The continent of the proxy.

country: Option<Vec<StringFilter>>

The country of the proxy.

state: Option<Vec<StringFilter>>

The state of the proxy.

city: Option<Vec<StringFilter>>

The city of the proxy.

datacenter: Option<bool>

Set explicitly to true to select a datacenter proxy.

residential: Option<bool>

Set explicitly to true to select a residential proxy.

mobile: Option<bool>

Set explicitly to true to select a mobile proxy.

carrier: Option<Vec<StringFilter>>

The mobile carrier desired.

asn: Option<Vec<Asn>>

Autonomous System Number (ASN).

Trait Implementations

impl Clone for ProxyFilter

fn clone(&self) -> ProxyFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyFilter

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

Formats the value using the given formatter.

impl Default for ProxyFilter

fn default() -> ProxyFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProxyFilter

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProxyFilter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProxyFilter

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProxyFilter

fn eq(&self, other: &ProxyFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProxyFilter

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const SEPARATOR: char> UsernameLabelWriter<SEPARATOR> for ProxyFilter

fn write_labels( &self, composer: &mut Composer<SEPARATOR>, ) -> Result<(), ComposeError>

Write all labels into the given Composer.

impl Eq for ProxyFilter

impl StructuralPartialEq for ProxyFilter