Struct UserAgentEmulateLayer

pub struct UserAgentEmulateLayer<P> { /* private fields */ }

A layer that emulates a user agent profile.

See UserAgentEmulateService for more details.

This layer is used to emulate a user agent profile for a request. It makes use of a UserAgentProvider (P) to select a user agent profile.

Implementations

impl<P> UserAgentEmulateLayer<P>

pub fn new(provider: P) -> UserAgentEmulateLayer<P>

Create a new UserAgentEmulateLayer with the given provider.

pub fn optional(self, optional: bool) -> UserAgentEmulateLayer<P>

When no user agent profile was found it will fail the request unless optional is true. In case of the latter the service will do nothing.

pub fn set_optional(&mut self, optional: bool) -> &mut UserAgentEmulateLayer<P>

See Self::optional.

pub fn try_auto_detect_user_agent( self, try_auto_detect_user_agent: bool, ) -> UserAgentEmulateLayer<P>

If true, the layer will try to auto-detect the user agent from the request, but only in case that info is not yet found in the context.

pub fn set_try_auto_detect_user_agent( &mut self, try_auto_detect_user_agent: bool, ) -> &mut UserAgentEmulateLayer<P>

See Self::try_auto_detect_user_agent.

pub fn input_header_order(self, name: HeaderName) -> UserAgentEmulateLayer<P>

Define a header that if present is to contain a CSV header name list, that allows you to define the desired header order for the (extra) headers found in the input (http) request.

Extra meaning any headers not considered a base header and already defined by the (selected) User Agent Profile.

This can be useful because your http client might not respect the header casing and/or order of the headers taken together. Using this metadata allows you to communicate this data through anyway. If however your http client does respect casing and order, or you don’t care about some of it, you might not need it.

pub fn set_input_header_order( &mut self, name: HeaderName, ) -> &mut UserAgentEmulateLayer<P>

See Self::input_header_order.

pub fn select_fallback( self, fb: UserAgentSelectFallback, ) -> UserAgentEmulateLayer<P>

Choose what to do in case no profile could be selected using the regular pre-conditions as specified by the provider.

pub fn set_select_fallback( &mut self, fb: UserAgentSelectFallback, ) -> &mut UserAgentEmulateLayer<P>

See Self::select_fallback.

Trait Implementations

impl<P> Clone for UserAgentEmulateLayer<P>

where P: Clone,

fn clone(&self) -> UserAgentEmulateLayer<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for UserAgentEmulateLayer<P>

where P: Debug,

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

Formats the value using the given formatter.

impl<S, P> Layer<S> for UserAgentEmulateLayer<P>

where P: Clone,

type Service = UserAgentEmulateService<S, P>

The service produced by the layer.

fn layer(&self, inner: S) -> <UserAgentEmulateLayer<P> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> <UserAgentEmulateLayer<P> as Layer<S>>::Service

Same as layer but consuming self after the service was created.