Skip to main content

ClientOptionsBuilder

Struct ClientOptionsBuilder

pub struct ClientOptionsBuilder { /* private fields */ }

Expand description

Builder for ClientOptions.

Implementations§

impl ClientOptionsBuilder

pub fn host<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Host URL for the PostHog API (defaults to US ingestion endpoint)

pub fn api_key(&mut self, value: String) -> &mut Self

Project API key. If missing or blank, the client is disabled.

pub fn request_timeout_seconds(&mut self, value: u64) -> &mut Self

Request timeout in seconds

pub fn personal_api_key<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

Personal API key for fetching flag definitions (required for local evaluation)

pub fn enable_local_evaluation(&mut self, value: bool) -> &mut Self

Enable local evaluation of feature flags

pub fn poll_interval_seconds(&mut self, value: u64) -> &mut Self

Interval for polling flag definitions (in seconds)

pub fn disabled(&mut self, value: bool) -> &mut Self

Disable tracking (useful for development)

pub fn disable_geoip(&mut self, value: bool) -> &mut Self

Disable automatic geoip enrichment

pub fn feature_flags_request_timeout_seconds(&mut self, value: u64) -> &mut Self

Feature flags request timeout in seconds

pub fn local_evaluation_only(&mut self, value: bool) -> &mut Self

When true, never fall back to the remote API for flag evaluation. If local evaluation is inconclusive (flag not cached or missing properties), the SDK returns Ok(None) instead of making a network call. Only meaningful when enable_local_evaluation is also true.

impl ClientOptionsBuilder

pub fn build(&self) -> Result<ClientOptions, ClientOptionsBuilderError>

Build sanitized ClientOptions.

Missing or whitespace-only API keys are allowed and disable the client so SDK initialization remains infallible while avoiding requests with an empty API key.

Trait Implementations§

impl Clone for ClientOptionsBuilder

fn clone(&self) -> ClientOptionsBuilder

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Default for ClientOptionsBuilder

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for ClientOptionsBuilder

impl RefUnwindSafe for ClientOptionsBuilder

impl Send for ClientOptionsBuilder

impl Sync for ClientOptionsBuilder

impl Unpin for ClientOptionsBuilder

impl UnsafeUnpin for ClientOptionsBuilder

impl UnwindSafe for ClientOptionsBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn into(self) -> U

Calls U::from(self).

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

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

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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