Struct ClientOptions 

pub struct ClientOptions {
    pub api_key: Option<ApiKey>,
    pub host: Host,
    pub shutdown_timeout: Duration,
    pub before_send: Vec<BeforeSendFn>,
}

Configuration for the PostHog client.

Fields

api_key: Option<ApiKey>

The PostHog API key. If None, the client will not be initialized.

host: Host

The target PostHog host.

shutdown_timeout: Duration

Timeout for graceful shutdown (default: 2 seconds).

before_send: Vec<BeforeSendFn>

Hooks to modify or filter events before sending.

Implementations

impl ClientOptions

pub fn new<T: Into<ApiKey>>(api_key: T) -> Self

Creates a new ClientOptions with the given API key and default settings.

Trait Implementations

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.

impl<T: Into<ApiKey>> From<(T, ClientOptions)> for ClientOptions

fn from((api_key, options): (T, Self)) -> Self

Converts to this type from the input type.

impl<T: Into<ApiKey>> From<T> for ClientOptions

fn from(api_key: T) -> Self

Converts to this type from the input type.