Struct Identity 

pub struct Identity(/* private fields */);

Who a request appears to come from: a name, an optional proxy, and the headers it sends.

Identities are compared and hashed by name. Cloning is cheap.

Implementations

impl Identity

pub fn new(name: impl Into<Box<str>>) -> Self

Creates an identity named name, with no proxy and no headers.

pub fn require_no_proxy(&self) -> Result<()>

Fails if requests should go through a proxy: for a backend that cannot route through one, so it never sends them from the crawler’s own IP instead.

Errors

Returns an Invalid error if the identity has a proxy.

pub fn with_proxy<U>(self, proxy: U) -> Result<Self>

where U: TryInto<Uri>, U::Error: Into<Error>,

Sends requests through proxy, an http, https or socks5 URL, with credentials if it needs them.

Errors

Returns an Invalid error if proxy is malformed or not absolute.

pub fn with_header(self, name: impl IntoHeaderName, value: HeaderValue) -> Self

Sends name with value on every request, unless the request sets it itself.

pub fn with_profile(self, profile: Profile) -> Self

Available on crate feature user-agents only.

Presents as this browser profile. Identity headers override the profile’s headers, and request headers override both.

Real browser backends refuse profiles: their own browser supplies its user agent and client hints.

pub fn profile(&self) -> Option<&Profile>

Available on crate feature user-agents only.

Returns the browser profile, kept separate from identity headers.

pub fn require_no_profile(&self) -> Result<()>

Fails if this identity has a browser profile, for backends whose real browser supplies its own user agent and client hints.

Errors

Returns an Invalid error if a profile is set. Without user-agents, always succeeds.

pub fn name(&self) -> &str

Returns the name.

pub fn proxy(&self) -> Option<&Uri>

Returns the proxy, if requests go through one.

pub fn headers(&self) -> &HeaderMap

Returns the identity headers, excluding its browser profile.

pub fn downgrade(&self) -> WeakIdentity

Returns a weak reference to this identity, which tells whether it is still in use: once the crawl retires it and its last request ends, it is gone. Backends use it to drop what they keep per identity, such as a client or a browser profile.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

Shows the proxy without its credentials.

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

Formats the value using the given formatter.

impl Eq for Identity

impl Hash for Identity

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

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 Identity

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

Equality operator ==.

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

Inequality operator !=.