rama::ua::emulate

Struct UserAgentEmulateService

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

Service to select a [UserAgentProfile] and inject its info into the input Context.

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) -> UserAgentEmulateService<S, P>

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

Provider is implicitly expected to be a UserAgentProvider.

pub fn optional(self, optional: bool) -> UserAgentEmulateService<S, 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 UserAgentEmulateService<S, P>

See Self::optional.

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

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 UserAgentEmulateService<S, P>

See Self::try_auto_detect_user_agent.

pub fn input_header_order( self, name: HeaderName, ) -> UserAgentEmulateService<S, 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 UserAgentEmulateService<S, P>

See Self::input_header_order.

pub fn select_fallback( self, fb: UserAgentSelectFallback, ) -> UserAgentEmulateService<S, 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 UserAgentEmulateService<S, P>

See Self::select_fallback.

Trait Implementations§

§

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

§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

impl<Body, S, P> Service<Request<Body>> for UserAgentEmulateService<S, P>
where Body: Send + Sync + 'static, S: Service<Request<Body>>, <S as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>, P: UserAgentProvider,

§

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

The type of response returned by the service.
§

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

The type of error returned by the service.
§

async fn serve( &self, ctx: Context, req: Request<Body>, ) -> Result<<UserAgentEmulateService<S, P> as Service<Request<Body>>>::Response, <UserAgentEmulateService<S, P> as Service<Request<Body>>>::Error>

Serve a response or error for the given request, using the given context.
§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

impl<S, P> !Freeze for UserAgentEmulateService<S, P>

§

impl<S, P> RefUnwindSafe for UserAgentEmulateService<S, P>
where S: RefUnwindSafe, P: RefUnwindSafe,

§

impl<S, P> Send for UserAgentEmulateService<S, P>
where S: Send, P: Send,

§

impl<S, P> Sync for UserAgentEmulateService<S, P>
where S: Sync, P: Sync,

§

impl<S, P> Unpin for UserAgentEmulateService<S, P>
where S: Unpin, P: Unpin,

§

impl<S, P> UnwindSafe for UserAgentEmulateService<S, P>
where S: UnwindSafe, P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<S, Request, Connection> ConnectorService<Request> for S
where S: Service<Request, Response = EstablishedClientConnection<Connection, Request>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

type Connection = Connection

Connection returned by the ConnectorService
§

type Error = <S as Service<Request>>::Error

Error returned in case of connection / setup failure
§

fn connect( &self, ctx: Context, req: Request, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Request>>::Connection, Request>, <S as ConnectorService<Request>>::Error>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<S, Body> HttpClientExt for S
where S: Service<Request, Response = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

type ExecuteResponse = Response<Body>

The response type returned by the execute method.
§

type ExecuteError = <S as Service<Request>>::Error

The error type returned by the execute method.
§

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more
§

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more
§

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more
§

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more
§

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more
§

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more
§

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a CONNECT request to a URL. Read more
§

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Start building a Request with the Method and Url. Read more
§

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

Start building a Request, using the given Request. Read more
§

fn execute( &self, ctx: Context, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

Executes a Request. Read more
§

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request, Response = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.
§

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.
§

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocketRequestBuilder starting from the given request. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaFrom<T> for U
where U: From<T>,

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

§

impl<S, RequestIn, RequestOut> RequestInspector<RequestIn> for S
where S: Service<RequestIn, Response = (Context, RequestOut)>, RequestIn: Send + 'static, RequestOut: Send + 'static,

§

type Error = <S as Service<RequestIn>>::Error

The type of error returned by the service.
§

type RequestOut = RequestOut

§

fn inspect_request( &self, ctx: Context, req: RequestIn, ) -> impl Future<Output = Result<(Context, <S as RequestInspector<RequestIn>>::RequestOut), <S as RequestInspector<RequestIn>>::Error>> + Send

Inspect the request, modify it if needed or desired, and return it.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,