1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
#![warn(
clippy::cargo,
clippy::missing_docs_in_private_items,
clippy::nursery,
clippy::pedantic,
missing_docs
)]
#![doc = include_str!("../README.md")]
use std::{
fmt::Debug,
os::raw::{c_char, c_int, c_void},
};
/// Char type for Windows APIs.
#[allow(non_camel_case_types)]
pub type c_wchar = u16;
/// SDK Version
pub const SDK_USER_AGENT: &str = "sentry.native/0.4.9";
/// The Sentry Client Options.
///
/// See <https://docs.sentry.io/error-reporting/configuration/>
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct Options([u8; 0]);
/// Represents a Sentry protocol value.
///
/// The members of this type should never be accessed. They are only here
/// so that alignment for the type can be properly determined.
///
/// Values must be released with `sentry_value_decref`. This lowers the
/// internal refcount by one. If the refcount hits zero it's freed. Some
/// values like primitives have no refcount (like null) so operations on
/// those are no-ops.
///
/// In addition values can be frozen. Some values like primitives are always
/// frozen but lists and dicts are not and can be frozen on demand. This
/// automatically happens for some shared values in the event payload like
/// the module list.
#[repr(C)]
#[derive(Copy, Clone)]
#[allow(clippy::missing_docs_in_private_items)]
pub union Value {
_bits: u64,
_double: f64,
_bindgen_union_align: u64,
}
/// A UUID
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct Uuid {
/// Bytes of the uuid.
pub bytes: [c_char; 16],
}
/// Sentry levels for events and breadcrumbs.
#[repr(i32)]
#[derive(Debug, Copy, Clone)]
pub enum Level {
/// Debug
Debug = -1,
/// Info
Info = 0,
/// Warning
Warning = 1,
/// Error
Error = 2,
/// Fatal
Fatal = 3,
}
/// Type of a Sentry value.
#[repr(i32)]
#[derive(Debug, Copy, Clone)]
pub enum ValueType {
/// Null
Null = 0,
/// Bool
Bool = 1,
/// Integer
Int = 2,
/// Double
Double = 3,
/// String
String = 4,
/// List
List = 5,
/// Object
Object = 6,
}
/// The state of user consent.
#[repr(i32)]
#[derive(Debug, Copy, Clone)]
pub enum UserConsent {
/// Unknown
Unknown = -1,
/// Given
Given = 1,
/// Revoked
Revoked = 0,
}
/// This represents an interface for user-defined transports.
///
/// Transports are responsible for sending envelopes to sentry and are the last
/// step in the event pipeline.
///
/// Envelopes will be submitted to the transport in a _fire and forget_ fashion,
/// and the transport must send those envelopes _in order_.
///
/// A transport has the following hooks, all of which
/// take the user provided `state` as last parameter. The transport state needs
/// to be set with `sentry_transport_set_state` and typically holds handles and
/// other information that can be reused across requests.
///
/// * `send_func`: This function will take ownership of an envelope, and is
/// responsible for freeing it via `sentry_envelope_free`.
/// * `startup_func`: This hook will be called by sentry inside of `sentry_init`
/// and instructs the transport to initialize itself. Failures will bubble up
/// to `sentry_init`.
/// * `shutdown_func`: Instructs the transport to flush its queue and shut down.
/// This hook receives a millisecond-resolution `timeout` parameter and should
/// return `true` when the transport was flushed and shut down successfully.
/// In case of `false`, sentry will log an error, but continue with freeing
/// the transport.
/// * `free_func`: Frees the transports `state`. This hook might be called even
/// though `shutdown_func` returned `false` previously.
///
/// The transport interface might be extended in the future with hooks to flush
/// its internal queue without shutting down, and to dump its internal queue to
/// disk in case of a hard crash.
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct Transport([u8; 0]);
/// A Sentry Envelope.
///
/// The Envelope is an abstract type which represents a payload being sent to
/// sentry. It can contain one or more items, typically an Event.
/// See <https://develop.sentry.dev/sdk/envelopes/>
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct Envelope([u8; 0]);
/// Type of the `before_send` callback.
///
/// The callback takes ownership of the `event`, and should usually return that
/// same event. In case the event should be discarded, the callback needs to
/// call `sentry_value_decref` on the provided event, and return a
/// `sentry_value_new_null()` instead.
///
/// This function may be invoked inside of a signal handler and must be safe for
/// that purpose, see <https://man7.org/linux/man-pages/man7/signal-safety.7.html>.
/// On Windows, it may be called from inside of a `UnhandledExceptionFilter`,
/// see the documentation on SEH (structured exception handling) for more
/// information <https://docs.microsoft.com/en-us/windows/win32/debug/structured-exception-handling>
pub type EventFunction =
extern "C" fn(event: Value, hint: *mut c_void, closure: *mut c_void) -> Value;
/// Type of the callback for logger function.
pub type LoggerFunction =
extern "C" fn(level: i32, message: *const c_char, args: *mut c_void, userdata: *mut c_void);
/// Type of callback for sending envelopes to a Sentry service
pub type SendEnvelopeFunction = extern "C" fn(envelope: *mut Envelope, state: *mut c_void);
/// Type of the callback for starting up a custom transport
pub type StartupFunction = extern "C" fn(options: *const Options, state: *mut c_void) -> c_int;
/// Type of the callback for shutting down a custom transport
pub type ShutdownFunction = extern "C" fn(timeout: u64, state: *mut c_void) -> c_int;
extern "C" {
/// Releases memory allocated from the underlying allocator.
#[link_name = "sentry_free"]
pub fn free(ptr: *mut c_void);
/// Increments the reference count on the value.
#[link_name = "sentry_value_incref"]
pub fn value_incref(value: Value);
/// Decrements the reference count on the value.
#[link_name = "sentry_value_decref"]
pub fn value_decref(value: Value);
/// Creates a null value.
#[link_name = "sentry_value_new_null"]
pub fn value_new_null() -> Value;
/// Creates a new 32-bit signed integer value.
#[link_name = "sentry_value_new_int32"]
pub fn value_new_int32(value: i32) -> Value;
/// Creates a new double value.
#[link_name = "sentry_value_new_double"]
pub fn value_new_double(value: f64) -> Value;
/// Creates a new boolen value.
#[link_name = "sentry_value_new_bool"]
pub fn value_new_bool(value: c_int) -> Value;
/// Creates a new null terminated string.
#[link_name = "sentry_value_new_string"]
pub fn value_new_string(value: *const c_char) -> Value;
/// Creates a new list value.
#[link_name = "sentry_value_new_list"]
pub fn value_new_list() -> Value;
/// Creates a new object.
#[link_name = "sentry_value_new_object"]
pub fn value_new_object() -> Value;
/// Returns the type of the value passed.
#[link_name = "sentry_value_get_type"]
pub fn value_get_type(value: Value) -> ValueType;
/// Sets a key to a value in the map.
///
/// This moves the ownership of the value into the map. The caller does not
/// have to call `sentry_value_decref` on it.
#[link_name = "sentry_value_set_by_key"]
pub fn value_set_by_key(value: Value, k: *const c_char, v: Value) -> c_int;
/// This removes a value from the map by key.
#[link_name = "sentry_value_remove_by_key"]
pub fn value_remove_by_key(value: Value, k: *const c_char) -> c_int;
/// 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.
#[link_name = "sentry_value_append"]
pub fn value_append(value: Value, v: Value) -> c_int;
/// Inserts a value into the list at a certain position.
///
/// This moves the ownership of the value into the list. The caller does
/// not have to call `sentry_value_decref` on it.
///
/// If the list is shorter than the given index it's automatically extended
/// and filled with `null` values.
#[link_name = "sentry_value_set_by_index"]
pub fn value_set_by_index(value: Value, index: usize, v: Value) -> c_int;
/// This removes a value from the list by index.
#[link_name = "sentry_value_remove_by_index"]
pub fn value_remove_by_index(value: Value, index: usize) -> c_int;
/// Looks up a value in a map by key. If missing a null value is
/// returned."] The returned value is borrowed."]
#[link_name = "sentry_value_get_by_key"]
pub fn value_get_by_key(value: Value, k: *const c_char) -> Value;
/// Looks up a value in a map by key. If missing a null value is returned.
/// The returned value is owned.
///
/// If the caller no longer needs the value it must be released with
/// `sentry_value_decref`.
#[link_name = "sentry_value_get_by_key_owned"]
pub fn value_get_by_key_owned(value: Value, k: *const c_char) -> Value;
/// Looks up a value in a list by index. If missing a null value is
/// returned. The returned value is borrowed.
#[link_name = "sentry_value_get_by_index"]
pub fn value_get_by_index(value: Value, index: usize) -> Value;
/// Looks up a value in a list by index. If missing a null value is
/// returned. The returned value is owned.
///
/// If the caller no longer needs the value it must be released with
/// `sentry_value_decref`.
#[link_name = "sentry_value_get_by_index_owned"]
pub fn value_get_by_index_owned(value: Value, index: usize) -> Value;
/// Returns the length of the given map or list.
///
/// If an item is not a list or map the return value is 0.
#[link_name = "sentry_value_get_length"]
pub fn value_get_length(value: Value) -> usize;
/// Converts a value into a 32bit signed integer.
#[link_name = "sentry_value_as_int32"]
pub fn value_as_int32(value: Value) -> i32;
/// Converts a value into a double value.
#[link_name = "sentry_value_as_double"]
pub fn value_as_double(value: Value) -> f64;
/// Returns the value as c string.
#[link_name = "sentry_value_as_string"]
pub fn value_as_string(value: Value) -> *const c_char;
/// Returns `true` if the value is boolean true.
#[link_name = "sentry_value_is_true"]
pub fn value_is_true(value: Value) -> c_int;
/// Creates a new empty Event value.
///
/// See <https://docs.sentry.io/platforms/native/enriching-events/> for how to
/// further work with events, and <https://develop.sentry.dev/sdk/event-payloads/>
/// for a detailed overview of the possible properties of an Event.
#[link_name = "sentry_value_new_event"]
pub fn value_new_event() -> Value;
/// Creates a new Message Event value.
///
/// See <https://develop.sentry.dev/sdk/event-payloads/message/>
///
/// `logger` can be NULL to omit the logger value.
#[link_name = "sentry_value_new_message_event"]
pub fn value_new_message_event(level: i32, logger: *const c_char, text: *const c_char)
-> Value;
/// Creates a new Breadcrumb with a specific type and message.
///
/// See <https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/>
///
/// Either parameter can be NULL in which case no such attributes is
/// created.
#[link_name = "sentry_value_new_breadcrumb"]
pub fn value_new_breadcrumb(type_: *const c_char, message: *const c_char) -> Value;
/// Creates a new Exception value.
///
/// This is intended for capturing language-level exception, such as from a
/// try-catch block. `type` and `value` here refer to the exception class
/// and a possible description.
///
/// See <https://develop.sentry.dev/sdk/event-payloads/exception/>
///
/// The returned value needs to be attached to an event via
/// `sentry_event_add_exception`.
#[link_name = "sentry_value_new_exception"]
pub fn value_new_exception(type_: *const c_char, value: *const c_char) -> Value;
/// Creates a new Thread value.
///
/// See <https://develop.sentry.dev/sdk/event-payloads/threads/>
///
/// The returned value needs to be attached to an event via
/// `sentry_event_add_thread`.
///
/// `name` can be NULL.
#[link_name = "sentry_value_new_thread"]
pub fn value_new_thread(id: u64, value: *const c_char) -> Value;
/// Creates a new Stack Trace conforming to the Stack Trace Interface.
///
/// See <https://develop.sentry.dev/sdk/event-payloads/stacktrace/>
///
/// The returned object needs to be attached to either an exception
/// event, or a thread object.
///
/// If `ips` is NULL the current stack trace is captured, otherwise `len`
/// stack trace instruction pointers are attached to the event.
#[link_name = "sentry_value_new_stacktrace"]
pub fn value_new_stacktrace(ips: *mut *mut c_void, len: usize) -> Value;
/// Adds an Exception to an Event value.
///
/// This takes ownership of the `exception`.
#[link_name = "sentry_event_add_exception"]
pub fn event_add_exception(event: Value, exception: Value);
/// Adds a Thread to an Event value.
///
/// This takes ownership of the `thread`.
#[link_name = "sentry_event_add_thread"]
pub fn event_add_thread(event: Value, thread: Value);
/// Serialize a Sentry value to msgpack.
///
/// The string is freshly allocated and must be freed with
/// `sentry_string_free`. Since msgpack is not zero terminated
/// the size is written to the `size_out` parameter.
#[link_name = "sentry_value_to_msgpack"]
pub fn value_to_msgpack(value: Value, size_out: *mut usize) -> *mut c_char;
/// Adds a stack trace to an event.
///
/// The stack trace is added as part of a new thread object.
/// This function is **deprecated** in favor of using
/// `sentry_value_new_stacktrace` in combination with
/// `sentry_value_new_thread` and `sentry_event_add_thread`.
///
/// If `ips` is NULL the current stack trace is captured, otherwise `len`
/// stack trace instruction pointers are attached to the event.
#[link_name = "sentry_event_value_add_stacktrace"]
pub fn event_value_add_stacktrace(event: Value, ips: *mut *mut c_void, len: usize);
/// Creates the nil uuid.
#[link_name = "sentry_uuid_nil"]
pub fn uuid_nil() -> Uuid;
/// Formats the uuid into a string buffer.
#[link_name = "sentry_uuid_as_string"]
pub fn uuid_as_string(uuid: *const Uuid, str: *mut c_char);
/// Frees an envelope.
#[link_name = "sentry_envelope_free"]
pub fn envelope_free(envelope: *mut Envelope);
/// Given an envelope returns the embedded event if there is one.
///
/// This returns a borrowed value to the event in the envelope.
#[link_name = "sentry_envelope_get_event"]
pub fn envelope_get_event(envelope: *const Envelope) -> Value;
/// Serializes the envelope.
///
/// The return value needs to be freed with `sentry_string_free()`.
#[link_name = "sentry_envelope_serialize"]
pub fn envelope_serialize(envelope: *const Envelope, size: *mut usize) -> *const c_char;
/// Creates a new transport with an initial `send_func`.
#[link_name = "sentry_transport_new"]
pub fn transport_new(send_func: Option<SendEnvelopeFunction>) -> *mut Transport;
/// Sets the transport `state`.
///
/// If the state is owned by the transport and needs to be freed, use
/// `transport_set_free_func` to set an appropriate hook.
#[link_name = "sentry_transport_set_state"]
pub fn transport_set_state(transport: *mut Transport, state: *mut c_void);
/// Sets the transport hook to free the transport `state`.
#[link_name = "sentry_transport_set_free_func"]
pub fn transport_set_free_func(
transport: *mut Transport,
free_func: Option<extern "C" fn(state: *mut c_void)>,
);
/// Sets the transport startup hook.
///
/// This hook is called from within `sentry_init` and will get a reference
/// to the options which can be used to initialize a transports internal
/// state. It should return `0` on success. A failure will bubble up to
/// `sentry_init`.
#[link_name = "sentry_transport_set_startup_func"]
pub fn transport_set_startup_func(
transport: *mut Transport,
startup_func: Option<StartupFunction>,
);
/// Sets the transport shutdown hook.
///
/// This hook will receive a millisecond-resolution timeout.
/// It should return `0` on success in case all the pending envelopes have
/// been sent within the timeout, or `1` if the timeout was hit.
#[link_name = "sentry_transport_set_shutdown_func"]
pub fn transport_set_shutdown_func(
transport: *mut Transport,
shutdown_func: Option<ShutdownFunction>,
);
/// Generic way to free a transport.
#[link_name = "sentry_transport_free"]
pub fn transport_free(transport: *mut Transport);
/// Creates a new options struct.
/// Can be freed with `sentry_options_free`.
#[link_name = "sentry_options_new"]
pub fn options_new() -> *mut Options;
/// Deallocates previously allocated Sentry options.
#[link_name = "sentry_options_free"]
pub fn options_free(opts: *mut Options);
/// Sets a transport.
#[link_name = "sentry_options_set_transport"]
pub fn options_set_transport(opts: *mut Options, transport: *mut Transport);
/// Sets the `before_send` callback.
///
/// See the `sentry_event_function_t` typedef above for more information.
#[link_name = "sentry_options_set_before_send"]
pub fn options_set_before_send(
opts: *mut Options,
func: Option<EventFunction>,
data: *mut c_void,
);
/// Sets the DSN.
#[link_name = "sentry_options_set_dsn"]
pub fn options_set_dsn(opts: *mut Options, dsn: *const c_char);
/// Gets the DSN.
#[link_name = "sentry_options_get_dsn"]
pub fn options_get_dsn(opts: *const Options) -> *const c_char;
/// 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.
#[link_name = "sentry_options_set_sample_rate"]
pub fn options_set_sample_rate(opts: *mut Options, sample_rate: f64);
/// Gets the sample rate.
#[link_name = "sentry_options_get_sample_rate"]
pub fn options_get_sample_rate(opts: *const Options) -> f64;
/// Sets the release.
#[link_name = "sentry_options_set_release"]
pub fn options_set_release(opts: *mut Options, release: *const c_char);
/// Gets the release.
#[link_name = "sentry_options_get_release"]
pub fn options_get_release(opts: *const Options) -> *const c_char;
/// Sets the environment.
#[link_name = "sentry_options_set_environment"]
pub fn options_set_environment(opts: *mut Options, environment: *const c_char);
/// Gets the environment.
#[link_name = "sentry_options_get_environment"]
pub fn options_get_environment(opts: *const Options) -> *const c_char;
/// Sets the dist.
#[link_name = "sentry_options_set_dist"]
pub fn options_set_dist(opts: *mut Options, dist: *const c_char);
/// Gets the dist.
#[link_name = "sentry_options_get_dist"]
pub fn options_get_dist(opts: *const Options) -> *const c_char;
/// Configures the http proxy.
///
/// The given proxy has to include the full scheme, eg. `http://some.proxy/`.
#[link_name = "sentry_options_set_http_proxy"]
pub fn options_set_http_proxy(opts: *mut Options, proxy: *const c_char);
/// Returns the configured http proxy.
#[link_name = "sentry_options_get_http_proxy"]
pub fn options_get_http_proxy(opts: *const Options) -> *const c_char;
/// Configures the path to a file containing ssl certificates for
/// verification.
#[link_name = "sentry_options_set_ca_certs"]
pub fn options_set_ca_certs(opts: *mut Options, path: *const c_char);
/// Returns the configured path for ca certificates.
#[link_name = "sentry_options_get_ca_certs"]
pub fn options_get_ca_certs(opts: *const Options) -> *const c_char;
/// Configures the name of the http transport thread.
#[link_name = "sentry_options_set_transport_thread_name"]
pub fn options_set_transport_thread_name(opts: *mut Options, name: *const c_char);
/// Returns the configured http transport thread name.
#[link_name = "sentry_options_get_transport_thread_name"]
pub fn options_get_transport_thread_name(opts: *const Options) -> *const c_char;
/// Enables or disables debug printing mode.
#[link_name = "sentry_options_set_debug"]
pub fn options_set_debug(opts: *mut Options, debug: c_int);
/// Returns the current value of the debug flag.
#[link_name = "sentry_options_get_debug"]
pub fn options_get_debug(opts: *const Options) -> c_int;
/// Sets the number of breadcrumbs being tracked and attached to events.
///
/// Defaults to 100.
#[link_name = "sentry_options_set_max_breadcrumbs"]
pub fn options_set_max_breadcrumbs(opts: *mut Options, max_breadcrumbs: usize);
/// Gets the number of breadcrumbs being tracked and attached to events.
#[link_name = "sentry_options_get_max_breadcrumbs"]
pub fn options_get_max_breadcrumbs(opts: *const Options) -> usize;
/// Sets the sentry-native logger function.
///
/// Used for logging debug events when the `debug` option is set to true.
#[link_name = "sentry_options_set_logger"]
pub fn options_set_logger(
opts: *mut Options,
logger_func: Option<LoggerFunction>,
userdata: *mut c_void,
);
/// Enables or disables automatic session tracking.
///
/// Automatic session tracking is enabled by default and is equivalent to
/// calling `sentry_start_session` after startup.
/// There can only be one running session, and the current session will
/// always be closed implicitly by `sentry_close`, when starting a
/// new session with `sentry_start_session`, or manually by calling
/// `sentry_end_session`.
#[link_name = "sentry_options_set_auto_session_tracking"]
pub fn options_set_auto_session_tracking(opts: *mut Options, val: c_int);
/// Returns true if automatic session tracking is enabled.
#[link_name = "sentry_options_get_auto_session_tracking"]
pub fn options_get_auto_session_tracking(opts: *const Options) -> c_int;
/// Enables or disabled user consent requirements for uploads.
///
/// This disables uploads until the user has given the consent to the SDK.
/// Consent itself is given with `sentry_user_consent_give` and
/// `sentry_user_consent_revoke`.
#[link_name = "sentry_options_set_require_user_consent"]
pub fn options_set_require_user_consent(opts: *mut Options, val: c_int);
/// Returns true if user consent is required.
#[link_name = "sentry_options_get_require_user_consent"]
pub fn options_get_require_user_consent(opts: *const Options) -> c_int;
/// Enables or disables on-device symbolication of stack traces.
///
/// This feature can have a performance impact, and is enabled by default on
/// Android. It is usually only needed when it is not possible to provide
/// debug information files for system libraries which are needed for
/// serverside symbolication.
#[link_name = "sentry_options_set_symbolize_stacktraces"]
pub fn options_set_symbolize_stacktraces(opts: *const Options, val: c_int);
/// Returns true if on-device symbolication of stack traces is enabled.
#[link_name = "sentry_options_get_symbolize_stacktraces"]
pub fn options_get_symbolize_stacktraces(opts: *const Options) -> c_int;
/// Adds a new attachment to be sent along.
///
/// `path` is assumed to be in platform-specific filesystem path encoding.
/// API Users on windows are encouraged to use
/// `sentry_options_add_attachmentw` instead.
#[link_name = "sentry_options_add_attachment"]
pub fn options_add_attachment(opts: *mut Options, path: *const c_char);
/// Sets the path to the crashpad handler if the crashpad backend is used.
///
/// The path defaults to the `crashpad_handler`/`crashpad_handler.exe`
/// executable, depending on platform, which is expected to be present in
/// the same directory as the app executable.
///
/// It is recommended that library users set an explicit handler path,
/// depending on the directory/executable structure of their app.
///
/// `path` is assumed to be in platform-specific filesystem path encoding.
/// API Users on windows are encouraged to use
/// `sentry_options_set_handler_pathw` instead.
#[link_name = "sentry_options_set_handler_path"]
pub fn options_set_handler_path(opts: *mut Options, path: *const c_char);
/// Sets the path to the Sentry Database Directory.
///
/// Sentry will use this path to persist user consent, sessions, and other
/// artifacts in case of a crash. This will also be used by the crashpad
/// backend if it is configured.
///
/// The directory is used for "cached" data, which needs to persist across
/// application restarts to ensure proper flagging of release-health
/// sessions, but might otherwise be safely purged regularly.
///
/// It is roughly equivalent to the type of `AppData/Local` on Windows and
/// `XDG_CACHE_HOME` on Linux, and equivalent runtime directories on other
/// platforms.
///
/// It is recommended that users set an explicit absolute path, depending on
/// their apps runtime directory. The path will be created if it does not
/// exist, and will be resolved to an absolute path inside of `sentry_init`.
/// The directory should not be shared with other application
/// data/configuration, as sentry-native will enumerate and possibly delete
/// files in that directory. An example might be
/// `$XDG_CACHE_HOME/your-app/sentry`
///
/// If no explicit path it set, sentry-native will default to
/// `.sentry-native` in the current working directory, with no specific
/// platform-specific handling.
///
/// `path` is assumed to be in platform-specific filesystem path encoding.
/// API Users on windows are encouraged to use
/// `sentry_options_set_database_pathw` instead.
#[link_name = "sentry_options_set_database_path"]
pub fn options_set_database_path(opts: *mut Options, path: *const c_char);
/// Wide char version of `sentry_options_add_attachment`.
#[link_name = "sentry_options_add_attachmentw"]
pub fn options_add_attachmentw(opts: *mut Options, path: *const c_wchar);
/// Wide char version of `sentry_options_set_handler_path`.
#[link_name = "sentry_options_set_handler_pathw"]
pub fn options_set_handler_pathw(opts: *mut Options, path: *const c_wchar);
/// Wide char version of `sentry_options_set_database_path`
#[link_name = "sentry_options_set_database_pathw"]
pub fn options_set_database_pathw(opts: *mut Options, path: *const c_wchar);
/// Enables forwarding to the system crash reporter. Disabled by default.
///
/// This setting only has an effect when using Crashpad on macOS. If
/// enabled, Crashpad forwards crashes to the macOS system crash
/// reporter. Depending on the crash, this may impact the crash time.
/// Even if enabled, Crashpad may choose not to forward certain crashes.
#[link_name = "sentry_options_set_system_crash_reporter_enabled"]
pub fn options_set_system_crash_reporter_enabled(opts: *mut Options, enabled: c_int);
/// Initializes the Sentry SDK with the specified options.
///
/// This takes ownership of the options. After the options have been set
/// they cannot be modified any more.
/// Depending on the configured transport and backend, this function might
/// not be fully thread-safe.
/// Returns 0 on success.
#[link_name = "sentry_init"]
pub fn init(options: *mut Options) -> c_int;
/// Shuts down the Sentry client and forces transports to flush out.
///
/// Returns 0 on success.
#[link_name = "sentry_close"]
pub fn close() -> c_int;
/// This will lazily load and cache a list of all the loaded libraries.
///
/// Returns a new reference to an immutable, frozen list. The reference must
/// be released with `sentry_value_decref`.
#[link_name = "sentry_get_modules_list"]
pub fn get_modules_list() -> Value;
/// Clears the internal module cache.
///
/// For performance reasons, Sentry will cache the list of loaded libraries
/// when capturing events. This cache can get out-of-date when loading
/// or unloading libraries at runtime. It is therefore recommended to
/// call `sentry_clear_modulecache` when doing so, to make sure that the
/// next call to `sentry_capture_event` will have an up-to-date module
/// list.
#[link_name = "sentry_clear_modulecache"]
pub fn clear_modulecache();
/// Re-initializes the Sentry backend.
///
/// This is needed if a third-party library overrides the previously
/// installed signal handler. Calling this function can be potentially
/// dangerous and should only be done when necessary.
///
/// Returns 0 on success.
#[link_name = "sentry_reinstall_backend"]
pub fn reinstall_backend() -> c_int;
/// Gives user consent.
#[link_name = "sentry_user_consent_give"]
pub fn user_consent_give();
/// Revokes user consent.
#[link_name = "sentry_user_consent_revoke"]
pub fn user_consent_revoke();
/// Resets the user consent (back to unknown).
#[link_name = "sentry_user_consent_reset"]
pub fn user_consent_reset();
/// Checks the current state of user consent.
#[link_name = "sentry_user_consent_get"]
pub fn user_consent_get() -> UserConsent;
/// Sends a Sentry event.
#[link_name = "sentry_capture_event"]
pub fn capture_event(event: Value) -> Uuid;
/// Adds the breadcrumb to be sent in case of an event.
#[link_name = "sentry_add_breadcrumb"]
pub fn add_breadcrumb(breadcrumb: Value);
/// Sets the specified user.
#[link_name = "sentry_set_user"]
pub fn set_user(user: Value);
/// Removes a user.
#[link_name = "sentry_remove_user"]
pub fn remove_user();
/// Sets a tag.
#[link_name = "sentry_set_tag"]
pub fn set_tag(key: *const c_char, value: *const c_char);
/// Removes the tag with the specified key.
#[link_name = "sentry_remove_tag"]
pub fn remove_tag(key: *const c_char);
/// Sets extra information.
#[link_name = "sentry_set_extra"]
pub fn set_extra(key: *const c_char, value: Value);
/// Removes the extra with the specified key.
#[link_name = "sentry_remove_extra"]
pub fn remove_extra(key: *const c_char);
/// Sets a context object.
#[link_name = "sentry_set_context"]
pub fn set_context(key: *const c_char, value: Value);
/// Removes the context object with the specified key.
#[link_name = "sentry_remove_context"]
pub fn remove_context(key: *const c_char);
/// Sets the event fingerprint.
///
/// This accepts a variable number of arguments, and needs to be terminated
/// by a trailing `NULL`.
#[link_name = "sentry_set_fingerprint"]
pub fn set_fingerprint(fingerprint: *const c_char, ...);
/// Removes the fingerprint.
#[link_name = "sentry_remove_fingerprint"]
pub fn remove_fingerprint();
/// Sets the transaction.
#[link_name = "sentry_set_transaction"]
pub fn set_transaction(transaction: *const c_char);
/// Removes the transaction.
#[link_name = "sentry_remove_transaction"]
pub fn remove_transaction();
/// Sets the event level.
#[link_name = "sentry_set_level"]
pub fn set_level(level: i32);
/// Starts a new session.
#[link_name = "sentry_start_session"]
pub fn start_session();
/// Ends a session.
#[link_name = "sentry_end_session"]
pub fn end_session();
}