Expand description

sentry-contrib-native-sys

Crates.io License

Release: Build Docs

Master: Build Docs

Table of contents

Description

Unofficial FFI bindings to the Sentry Native SDK for Rust. This crate isn’t intended to be used directly, use sentry-contrib-native instead.

For more details see sentry-contrib-native’s README

Crate features

  • transport-default - Enabled by default, will use WinHttp on Windows and Curl everywhere else as the default transport.
  • backend-crashpad - Will use Crashpad.
  • backend-breakpad - Will use Breakpad.
  • backend-inproc - Will use InProc.

By default the selected backend will be Crashpad for Linux, MacOS and Windows and InProc for Android, even if no corresponding feature is active. See SENTRY_BACKEND for more information on backends.

License

Licensed under either of

at your option.

Attribution

Used documentation from Sentry Native SDK: MIT

See the ATTRIBUTION for more details.

Structs

A Sentry Envelope.

The Sentry Client Options.

This represents an interface for user-defined transports.

A UUID

Enums

Sentry levels for events and breadcrumbs.

The state of user consent.

Type of a Sentry value.

Constants

SDK Version

Functions

Adds the breadcrumb to be sent in case of an event.

Sends a Sentry event.

Clears the internal module cache.

Shuts down the Sentry client and forces transports to flush out.

Ends a session.

Frees an envelope.

Given an envelope returns the embedded event if there is one.

Serializes the envelope.

Adds an Exception to an Event value.

Adds a Thread to an Event value.

Adds a stack trace to an event.

Releases memory allocated from the underlying allocator.

This will lazily load and cache a list of all the loaded libraries.

Initializes the Sentry SDK with the specified options.

Adds a new attachment to be sent along.

Wide char version of sentry_options_add_attachment.

Deallocates previously allocated Sentry options.

Returns true if automatic session tracking is enabled.

Returns the configured path for ca certificates.

Returns the current value of the debug flag.

Gets the dist.

Gets the DSN.

Gets the environment.

Returns the configured http proxy.

Gets the number of breadcrumbs being tracked and attached to events.

Gets the release.

Returns true if user consent is required.

Gets the sample rate.

Returns true if on-device symbolication of stack traces is enabled.

Returns the configured http transport thread name.

Creates a new options struct. Can be freed with sentry_options_free.

Enables or disables automatic session tracking.

Sets the before_send callback.

Configures the path to a file containing ssl certificates for verification.

Sets the path to the Sentry Database Directory.

Wide char version of sentry_options_set_database_path

Enables or disables debug printing mode.

Sets the dist.

Sets the DSN.

Sets the environment.

Sets the path to the crashpad handler if the crashpad backend is used.

Wide char version of sentry_options_set_handler_path.

Configures the http proxy.

Sets the sentry-native logger function.

Sets the number of breadcrumbs being tracked and attached to events.

Sets the release.

Enables or disabled user consent requirements for uploads.

Sets the sample rate, which should be a double between 0.0 and 1.0. Sentry will randomly discard any event that is captured using sentry_capture_event when a sample rate < 1 is set.

Enables or disables on-device symbolication of stack traces.

Enables forwarding to the system crash reporter. Disabled by default.

Sets a transport.

Configures the name of the http transport thread.

Re-initializes the Sentry backend.

Removes the context object with the specified key.

Removes the extra with the specified key.

Removes the fingerprint.

Removes the tag with the specified key.

Removes the transaction.

Removes a user.

Sets a context object.

Sets extra information.

Sets the event fingerprint.

Sets the event level.

Sets a tag.

Sets the transaction.

Sets the specified user.

Starts a new session.

Generic way to free a transport.

Creates a new transport with an initial send_func.

Sets the transport hook to free the transport state.

Sets the transport shutdown hook.

Sets the transport startup hook.

Sets the transport state.

Checks the current state of user consent.

Gives user consent.

Resets the user consent (back to unknown).

Revokes user consent.

Formats the uuid into a string buffer.

Creates the nil uuid.

Appends a value to a list. This moves the ownership of the value into the list. The caller does not have to call sentry_value_decref on it.

Converts a value into a double value.

Converts a value into a 32bit signed integer.

Returns the value as c string.

Decrements the reference count on the value.

Looks up a value in a list by index. If missing a null value is returned. The returned value is borrowed.

Looks up a value in a list by index. If missing a null value is returned. The returned value is owned.

Looks up a value in a map by key. If missing a null value is returned.“] The returned value is borrowed.”]

Looks up a value in a map by key. If missing a null value is returned. The returned value is owned.

Returns the length of the given map or list.

Returns the type of the value passed.

Increments the reference count on the value.

Returns true if the value is boolean true.

Creates a new boolen value.

Creates a new Breadcrumb with a specific type and message.

Creates a new double value.

Creates a new empty Event value.

Creates a new Exception value.

Creates a new 32-bit signed integer value.

Creates a new list value.

Creates a new Message Event value.

Creates a null value.

Creates a new object.

Creates a new Stack Trace conforming to the Stack Trace Interface.

Creates a new null terminated string.

Creates a new Thread value.

This removes a value from the list by index.

This removes a value from the map by key.

Inserts a value into the list at a certain position.

Sets a key to a value in the map.

Serialize a Sentry value to msgpack.

Type Definitions

Type of the before_send callback.

Type of the callback for logger function.

Type of callback for sending envelopes to a Sentry service

Type of the callback for shutting down a custom transport

Type of the callback for starting up a custom transport

Char type for Windows APIs.

Unions

Represents a Sentry protocol value.