Struct sentry_contrib_native::Shutdown

pub struct Shutdown;

Automatically shuts down the Sentry client on drop.

Examples

fn main() -> Result<()> {
    let options = Options::new();
    let _shutdown: Shutdown = options.init()?;

    // ...
    // your application code
    // ...

    Ok(())
    // Sentry client will automatically shutdown because `Shutdown` is leaving context
}

Implementations

impl Shutdown

pub fn forget(self)

Disable automatic shutdown. Call shutdown manually to force transports to flush out before the program exits.

Examples

fn main() -> Result<()> {
    sentry_init()?;

    // ...
    // your application code
    // ...

    // call shutdown manually to make sure transports flush out
    shutdown();
    Ok(())
}

fn sentry_init() -> Result<()> {
    let options = Options::new();
    // call forget because we are leaving the context and we don't want to shut down the Sentry client yet
    options.init()?.forget();
    Ok(())
}

pub fn shutdown(self)

Manually shutdown.

Examples

fn main() -> Result<()> {
    let options = Options::new();
    let shutdown = options.init()?;

    // ...
    // your application code
    // ...

    // call shutdown manually to make sure transports flush out
    shutdown.shutdown();
    Ok(())
}

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shutdown

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

Formats the value using the given formatter.

impl Drop for Shutdown

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Shutdown

impl Hash for Shutdown

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Shutdown

fn cmp(&self, other: &Shutdown) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Shutdown> for Shutdown

fn eq(&self, other: &Shutdown) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Shutdown> for Shutdown

fn partial_cmp(&self, other: &Shutdown) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Shutdown

impl StructuralPartialEq for Shutdown