Struct RawReportRef 

#[repr(transparent)]
pub struct RawReportRef<'a> {
    ptr: NonNull<ReportData<Erased>>,
    _marker: PhantomData<&'a ReportData<Erased>>,
}

A lifetime-bound 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.

We cannot use a &'a ReportData<C> directly, because that would require us to know the actual type of the context, which we do not.

Safety invariants

This reference behaves like a &'a ReportData<C> for some unknown C and upholds the usual safety invariants of shared references:

1. The pointee is properly initialized for the entire lifetime 'a.
2. The pointee is not mutated for the entire lifetime 'a.

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.

_marker: PhantomData<&'a ReportData<Erased>>

Marker to tell the compiler that we should behave the same as a &'a ReportData<Erased>

Implementations

impl<'a> RawReportRef<'a>

pub(super) fn vtable(self) -> &'static ReportVtable

Returns a reference to the ReportVtable of this report.

The returned vtable is guaranteed to match the context type stored in the ReportData.

pub fn children(self) -> &'a Vec<RawReport>

Returns the child reports of this report.

pub fn attachments(self) -> &'a Vec<RawAttachment>

Returns the attachments of this report.

pub unsafe fn context_downcast_unchecked<C: 'static>(self) -> &'a C

Downcasts the context to the specified type and returns a reference.

Safety

The caller must ensure:

1. The type C matches the actual context type stored in the ReportData

impl<'a> RawReportRef<'a>

pub(super) unsafe fn cast_inner<C>(self) -> &'a ReportData<C>

Casts the RawReportRef to a ReportData<C> reference.

Safety

The caller must ensure:

1. The type C matches the actual context type stored in the ReportData

pub(super) fn as_ptr(self) -> *const ReportData<Erased>

Returns a NonNull pointer to the ReportData instance.

pub fn context_type_id(self) -> TypeId

Returns the TypeId of the context.

pub fn context_handler_type_id(self) -> TypeId

Returns the TypeId of the context.

pub fn context_source(self) -> Option<&'a (dyn Error + 'static)>

Returns the source of the context using the ContextHandler::source method specified when the ReportData was created.

pub fn context_display(self, formatter: &mut Formatter<'_>) -> Result

Formats the context by using the ContextHandler::display method specified by the handler used to create the ReportData.

pub fn context_debug(self, formatter: &mut Formatter<'_>) -> Result

Formats the context by using the ContextHandler::debug method specified by the handler used to create the ReportData.

pub fn preferred_context_formatting_style( self, report_formatting_function: FormattingFunction, ) -> ContextFormattingStyle

The formatting style preferred by the context when formatted as part of a report.

Arguments

• report_formatting_function: Whether the report in which this context will be embedded is being formatted using Display formatting or Debug

pub unsafe fn clone_arc(self) -> RawReport

Clones the inner triomphe::Arc and returns a new RawReport pointing to the same data.

Safety

The caller must ensure:

1. All other references to this report are compatible with shared ownership. Specifically none of them assume that the strong_count is 1.

pub fn strong_count(self) -> usize

Gets the strong_count of the inner triomphe::Arc.

Trait Implementations

impl<'a> Clone for RawReportRef<'a>

fn clone(&self) -> RawReportRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RawReportRef<'a>