Struct Envelope

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§

§

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.

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

Creates a new Envelope from slice.

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

Creates a new raw Envelope from the given buffer.

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

Creates a new Envelope from path.

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

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§

§

impl Clone for Envelope

§

fn clone(&self) -> Envelope

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Envelope

§

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

Formats the value using the given formatter. Read more
§

impl Default for Envelope

§

fn default() -> Envelope

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

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

§

fn from(item: T) -> Envelope

Converts to this type from the input type.
§

impl PartialEq for Envelope

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

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

Source§

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>,

Source§

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>,

Source§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T