Skip to main content

HcaptchaTaskBuilder

Struct HcaptchaTaskBuilder 

Source
pub struct HcaptchaTaskBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> HcaptchaTaskBuilder<S>

Source

pub fn build(self) -> HcaptchaTask
where S: IsComplete,

Finish building and return the requested object

Source

pub fn website_url( self, value: impl Into<String>, ) -> HcaptchaTaskBuilder<SetWebsiteUrl<S>>
where S::WebsiteUrl: IsUnset,

Required.

URL of the page containing the challenge.

Source

pub fn website_key( self, value: impl Into<String>, ) -> HcaptchaTaskBuilder<SetWebsiteKey<S>>
where S::WebsiteKey: IsUnset,

Required.

HCaptcha site key.

Source

pub fn lang(self, value: impl Into<String>) -> HcaptchaTaskBuilder<SetLang<S>>
where S::Lang: IsUnset,

Required.

Browser language. Only en-US is supported at the moment.

Source

pub fn proxy(self, value: impl Into<String>) -> HcaptchaTaskBuilder<SetProxy<S>>
where S::Proxy: IsUnset,

Optional (Some / Option setters). Optional proxy forwarded to the worker.

Source

pub fn maybe_proxy( self, value: Option<impl Into<String>>, ) -> HcaptchaTaskBuilder<SetProxy<S>>
where S::Proxy: IsUnset,

Optional (Some / Option setters). Optional proxy forwarded to the worker.

Source

pub fn invisible(self, value: bool) -> HcaptchaTaskBuilder<SetInvisible<S>>
where S::Invisible: IsUnset,

Required.

Whether the challenge runs without a visible checkbox.

True when the site shows no hCaptcha checkbox, false when it does.

Source

pub fn rq_data( self, value: impl Into<String>, ) -> HcaptchaTaskBuilder<SetRqData<S>>
where S::RqData: IsUnset,

Optional (Some / Option setters). Optional rqdata value, required by the sites that publish one.

The wire name is all lowercase here, unlike the Cloudflare types, whose equivalent field is rqData. The two are not interchangeable.

Source

pub fn maybe_rq_data( self, value: Option<impl Into<String>>, ) -> HcaptchaTaskBuilder<SetRqData<S>>
where S::RqData: IsUnset,

Optional (Some / Option setters). Optional rqdata value, required by the sites that publish one.

The wire name is all lowercase here, unlike the Cloudflare types, whose equivalent field is rqData. The two are not interchangeable.

Source

pub fn extra(self, value: ExtraFields) -> HcaptchaTaskBuilder<SetExtra<S>>
where S::Extra: IsUnset,

Optional (Some / Option setters). Default: <ExtraFields as Default>::default().

Additional worker parameters.

Source

pub fn maybe_extra( self, value: Option<ExtraFields>, ) -> HcaptchaTaskBuilder<SetExtra<S>>
where S::Extra: IsUnset,

Optional (Some / Option setters). Default: <ExtraFields as Default>::default().

Additional worker parameters.

Auto Trait Implementations§

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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