pub struct HotPathGuard { /* private fields */ }Expand description
RAII guard for hot path sections.
When created, enables allocation detection for the current thread. When dropped, disables allocation detection.
§Example
ⓘ
use laminar_core::alloc::HotPathGuard;
fn process_event(event: &Event) {
// Any allocation after this will panic (with allocation-tracking feature)
let _guard = HotPathGuard::enter("process_event");
// Do hot path processing...
// Vec::new() here would panic!
} // Guard dropped here, allocation detection disabled§Zero-Cost in Release Builds
Without the allocation-tracking feature, this guard compiles to a no-op.
The enter/drop methods are inlined to nothing.
Implementations§
Source§impl HotPathGuard
impl HotPathGuard
Sourcepub fn enter(section: &'static str) -> Self
pub fn enter(section: &'static str) -> Self
Enter a hot path section.
After calling this, any heap allocation on the current thread will panic
(when allocation-tracking feature is enabled).
§Arguments
section- Name of the hot path section (used in error messages)
§Returns
A guard that will disable detection when dropped.
§Example
ⓘ
let _guard = HotPathGuard::enter("reactor::poll");
// Hot path code hereSourcepub fn current_section(&self) -> &'static str
pub fn current_section(&self) -> &'static str
Get the current section name, if in hot path.
Trait Implementations§
Source§impl Debug for HotPathGuard
impl Debug for HotPathGuard
Auto Trait Implementations§
impl Freeze for HotPathGuard
impl RefUnwindSafe for HotPathGuard
impl !Send for HotPathGuard
impl !Sync for HotPathGuard
impl Unpin for HotPathGuard
impl UnsafeUnpin for HotPathGuard
impl UnwindSafe for HotPathGuard
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.