Struct sentry_types::protocol::v7::Envelope

source ·
pub struct Envelope { /* private fields */ }
Expand description

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§

source§

impl Envelope

source

pub fn new() -> Envelope

Creates a new empty Envelope.

source

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

Add a new Envelope Item.

source

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

Create an Iterator over all the EnvelopeItems.

source

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

Returns the Envelopes Uuid, if any.

source

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

Returns the Event contained in this Envelope, if any.

source

pub fn filter<P>(self, predicate: P) -> Option<Self>
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.

source

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

Serialize the Envelope into the given Write.

source

pub fn from_slice(slice: &[u8]) -> Result<Envelope, EnvelopeError>

Creates a new Envelope from slice.

source

pub fn from_bytes_raw(bytes: Vec<u8>) -> Result<Self, EnvelopeError>

Creates a new raw Envelope from the given buffer.

source

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Envelope, EnvelopeError>

Creates a new Envelope from path.

source

pub fn from_path_raw<P: AsRef<Path>>(path: P) -> Result<Self, EnvelopeError>

Creates a new Envelope from path without attempting to parse anything.

The resulting Envelope will have no event_id and the file contents will be contained verbatim in the items field.

Trait Implementations§

source§

impl Clone for Envelope

source§

fn clone(&self) -> Envelope

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Envelope

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Envelope

source§

fn default() -> Envelope

Returns the “default value” for a type. Read more
source§

impl<T> From<T> for Envelope
where T: Into<EnvelopeItem>,

source§

fn from(item: T) -> Self

Converts to this type from the input type.
source§

impl PartialEq for Envelope

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Envelope

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V