Struct UserAgentEmulateService 

pub struct UserAgentEmulateService<S, P> { /* private fields */ }

Service to select a UserAgentProfile and inject its info into the input Extensions.

Note that actual http emulation is done by also ensuring a service such as UserAgentEmulateHttpRequestModifier and UserAgentEmulateHttpConnectModifier is in use within your connector stack. Tls emulation is facilitated by a tls client connector which respects the injected (tls) client profile.

See the implementation ofEasyHttpWebClient for the reference implementation of how one can make use of this profile to emulate a user agent on the tls layer.

Implementations

impl<S, P> UserAgentEmulateService<S, P>

pub fn new(inner: S, provider: P) -> Self

Create a new UserAgentEmulateService with the given inner service and provider.

Provider is implicitly expected to be a UserAgentProvider.

pub fn with_is_optional(self, optional: bool) -> Self

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_is_optional(&mut self, optional: bool) -> &mut Self

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 with_try_auto_detect_user_agent( self, try_auto_detect_user_agent: bool, ) -> Self

If true, the service 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 Self

If true, the service 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 maybe_with_input_header_order(self, name: Option<HeaderName>) -> Self

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 maybe_set_input_header_order( &mut self, name: Option<HeaderName>, ) -> &mut Self

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 with_input_header_order(self, name: HeaderName) -> Self

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 Self

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 without_input_header_order(self) -> Self

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 unset_input_header_order(&mut self) -> &mut Self

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 maybe_with_select_fallback( self, fb: Option<UserAgentSelectFallback>, ) -> Self

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

pub fn maybe_set_select_fallback( &mut self, fb: Option<UserAgentSelectFallback>, ) -> &mut Self

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

pub fn with_select_fallback(self, fb: UserAgentSelectFallback) -> Self

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 Self

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

pub fn without_select_fallback(self) -> Self

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

pub fn unset_select_fallback(&mut self) -> &mut Self

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

Trait Implementations

impl<S: Clone, P: Clone> Clone for UserAgentEmulateService<S, P>

fn clone(&self) -> UserAgentEmulateService<S, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, P: Debug> Debug for UserAgentEmulateService<S, P>

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

Formats the value using the given formatter.

impl<Body, S, P> Service<Request<Body>> for UserAgentEmulateService<S, P>

where Body: Send + Sync + 'static, S: Service<Request<Body>, Error: Into<BoxError>>, P: UserAgentProvider,

type Output = <S as Service<Request<Body>>>::Output

The type of the output returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve(&self, req: Request<Body>) -> Result<Self::Output, Self::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.