Struct sentry_core::protocol::Envelope

pub struct Envelope { /* private fields */ }

A Sentry Envelope.

An Envelope is the data format that Sentry uses for Ingestion. It can contain multiple Items, some of which are related, such as Events, and Event Attachments. Other Items, such as Sessions are independent.

See the documentation on Envelopes for more details.

Implementations

impl Envelope

pub fn new() -> Envelope

Creates a new empty Envelope.

pub fn add_item<I>(&mut self, item: I) where
    I: Into<EnvelopeItem>, 

Add a new Envelope Item.

pub fn items(&self) -> EnvelopeItemIter<'_>

Create an Iterator over all the EnvelopeItems.

pub fn uuid(&self) -> Option<&Uuid>

Returns the Envelopes Uuid, if any.

pub fn event(&self) -> Option<&Event<'static>>

Returns the Event contained in this Envelope, if any.

pub fn filter<P>(self, predicate: P) -> Option<Envelope> where
    P: FnMut(&EnvelopeItem) -> bool, 

Filters the Envelope’s EnvelopeItems based on a predicate, and returns a new Envelope containing only the filtered items.

Retains the EnvelopeItems for which the predicate returns true. Additionally, EnvelopeItem::Attachments are only kept if the Envelope contains an EnvelopeItem::Event or EnvelopeItem::Transaction.

None is returned if no items remain in the Envelope after filtering.

pub fn to_writer<W>(&self, writer: W) -> Result<(), Error> where
    W: Write, 

Serialize the Envelope into the given Write.

Trait Implementations

impl Clone for Envelope

pub fn clone(&self) -> Envelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Default for Envelope

pub fn default() -> Envelope

Returns the “default value” for a type.

impl From<Event<'static>> for Envelope

pub fn from(event: Event<'static>) -> Envelope

Performs the conversion.

impl From<Transaction<'static>> for Envelope

pub fn from(transaction: Transaction<'static>) -> Envelope

Performs the conversion.

impl PartialEq<Envelope> for Envelope

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

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

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

This method tests for !=.

impl StructuralPartialEq for Envelope