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
//! This crate provides common types for working with the Sentry protocol or the //! Sentry server. It's used by the Sentry Relay infrastructure as well as the //! rust Sentry client. //! //! Since this library is used in the Sentry relay as well it depends on //! `serde_json` with the `preserve_order` feature. As such all maps used //! by the protocol are linked hash maps. //! //! Most of the types in this crate are serializable in one form or another. //! The types in the `protocol` module are generally really only serializable //! to JSON as other formats are not supported by Sentry at this date. //! //! ## Contents //! //! The crate provides a bunch of common types for working with Sentry as //! such (DSN, ProjectIDs, authentication headers) as well as types for //! the Sentry event protocol. //! //! Right now only `v7` of the protocol is implemented but it's versioned //! so later versions might be added later. //! //! ## API Concepts //! //! Most types are directly serializable or deserializable and try to implement //! the `Default` type. This means that objects can be created conviently //! and missing attributes can be filled in: //! //! ```rust //! use sentry_types::protocol::v7; //! //! let event = v7::Event { //! message: Some("Hello World!".to_string()), //! culprit: Some("foo in bar".to_string()), //! level: v7::Level::Info, //! ..Default::default() //! }; //! ``` #![warn(missing_docs)] #[macro_use] mod macros; mod auth; mod dsn; mod project_id; pub mod protocol; mod utils; pub use crate::auth::*; pub use crate::dsn::*; pub use crate::project_id::*; // Re-export external types and traits for convenience pub use chrono::{DateTime, ParseError as ChronoParseError, TimeZone, Utc}; pub use debugid::*; pub use uuid::{Uuid, Variant as UuidVariant, Version as UuidVersion};