Struct RawReport 

#[repr(transparent)]
pub struct RawReport {
    ptr: NonNull<ReportData<Erased>>,
}

A pointer to a ReportData that is guaranteed to point to an initialized instance of a ReportData<C> for some specific C, though we do not know which actual C it is.

However, the pointer is allowed to transition into a non-initialized state inside the RawReport::drop method.

The pointer is guaranteed to have been created using triomphe::Arc::into_raw.

We cannot use a triomphe::OffsetArc<ReportData<C>> directly, because that does not allow us to type-erase the C.

Fields

ptr: NonNull<ReportData<Erased>>

Pointer to the inner report data

Safety

The following safety invariants are guaranteed to be upheld as long as this struct exists:

1. The pointer must have been created from a triomphe::Arc<ReportData<C>> for some C using triomphe::Arc::into_raw.
2. The pointer will point to the same ReportData<C> for the entire lifetime of this object.

Implementations

impl RawReport

pub unsafe fn into_parts<C: 'static>( self, ) -> (C, Vec<RawReport>, Vec<RawAttachment>)

Deconstructs this report into its context, children, and attachments.

Safety

The caller must ensure:

1. The type C matches the actual context type stored in the ReportData
2. This is the only existing reference pointing to the inner ReportData

impl RawReport

pub(super) fn from_arc<C: 'static>(data: Arc<ReportData<C>>) -> Self

Creates a new RawReport from a triomphe::Arc<ReportData<C>>.

pub(super) fn into_non_null(self) -> NonNull<ReportData<Erased>>

Consumes the RawReport without decrementing the reference count and returns the inner pointer.

pub fn new<C, H>( context: C, children: Vec<RawReport>, attachments: Vec<RawAttachment>, ) -> Self

where C: 'static, H: ContextHandler<C>,

Creates a new RawReport with the specified handler, context, children, and attachments.

The created report will have the supplied context type and handler type. It will also have a strong count of 1.

pub fn as_ref(&self) -> RawReportRef<'_>

Returns a reference to the ReportData instance.

pub unsafe fn as_mut(&mut self) -> RawReportMut<'_>

Returns a mutable reference to the ReportData instance.

Safety

The caller must ensure:

1. This is the only existing reference pointing to the inner ReportData. Specifically the strong count of the inner triomphe::Arc must be 1.

Trait Implementations

impl Drop for RawReport

fn drop(&mut self)

Executes the destructor for this type.