Struct sentry::ClientInitGuard

#[must_use =
  "when the init guard is dropped the transport will be shut down and no further \
              events can be sent.  If you do want to ignore this use mem::forget on it."]pub struct ClientInitGuard(_);

Helper struct that is returned from init.

When this is dropped events are drained with a 1 second timeout.

Implementations

impl ClientInitGuard

pub fn is_enabled(&self) -> bool

Quick check if the client is enabled.

Methods from Deref<Target = Client>

pub fn options(&self) -> &ClientOptions

Returns the options of this client.

pub fn dsn(&self) -> Option<&Dsn>

Returns the DSN that constructed this client.

pub fn is_enabled(&self) -> bool

Quick check to see if the client is enabled.

The Client is enabled if it has a valid DSN and Transport configured.

Examples

use std::sync::Arc;

let client = sentry::Client::from(sentry::ClientOptions::default());
assert!(!client.is_enabled());

let dsn = "https://public@example.com/1";
let transport = sentry::test::TestTransport::new();
let client = sentry::Client::from((
    dsn,
    sentry::ClientOptions {
        transport: Some(Arc::new(transport)),
        ..Default::default()
    },
));
assert!(client.is_enabled());

pub fn capture_event(
    &self,
    event: Event<'static>,
    scope: Option<&Scope>
) -> Uuid

Captures an event and sends it to sentry.

pub fn close(&self, timeout: Option<Duration>) -> bool

Drains all pending events and shuts down the transport behind the client. After shutting down the transport is removed.

This returns true if the queue was successfully drained in the given time or false if not (for instance because of a timeout). If no timeout is provided the client will wait for as long a shutdown_timeout in the client options.

Trait Implementations

impl Deref for ClientInitGuard

type Target = Client

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for ClientInitGuard

fn drop(&mut self)

Executes the destructor for this type.