Struct mz_segment::Client

pub struct Client {
    pub(crate) client_side: bool,
    pub(crate) tx: Sender<BatchMessage>,
}

A Segment API client.

Event delivery is best effort. There is no guarantee that a given event will be delivered to Segment.

Fields

client_side: bool

tx: Sender<BatchMessage>

Implementations

impl Client

pub fn new(_: Config) -> Client

Creates a new client.

pub fn track<S>( &self, user_id: Uuid, event: S, properties: Value, context: Option<Value>, timestamp: Option<DateTime<Utc>>, )

where S: Into<String>,

Sends a new track event to Segment.

Delivery happens asynchronously on a background thread. It is best effort. There is no guarantee that the event will be delivered to Segment. Events may be dropped when the client is backlogged. Errors are logged but not returned.

pub fn group(&self, user_id: Uuid, group_id: Uuid, traits: Value)

Sends a new [group event] to Segment.

Delivery happens asynchronously on a background thread. It is best effort. There is no guarantee that the event will be delivered to Segment. Events may be dropped when the client is backlogged. Errors are logged but not returned.

pub(crate) fn send(&self, message: BatchMessage)

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.