pub struct PluginHandle { /* private fields */ }Expand description
2026-09-26: The plugin’s view of its host.
Implementations§
Source§impl PluginHandle
impl PluginHandle
pub fn new( run_id: u64, target: TargetEndpoint, artifacts: ArtifactStore, events: Sender<PluginEvent>, cancel: Arc<AtomicBool>, ) -> Self
pub fn target(&self) -> &TargetEndpoint
pub fn artifacts(&self) -> &ArtifactStore
pub fn log(&self, level: LogLevel, text: impl Into<String>)
pub fn info(&self, text: impl Into<String>)
pub fn warn(&self, text: impl Into<String>)
pub fn status(&self, text: impl Into<String>)
pub fn progress(&self, done: u64, total: u64)
pub fn set_glow(&self, on: bool)
pub fn is_cancelled(&self) -> bool
Sourcepub fn check_cancelled(&self) -> Result<()>
pub fn check_cancelled(&self) -> Result<()>
2026-09-26: Err("cancelled") once the run is cancelled. Call it at
every await point a benchmark controls: otherwise cancellation takes
effect only when the executor checks the flag, after each frame.
Trait Implementations§
Source§impl Clone for PluginHandle
impl Clone for PluginHandle
Source§fn clone(&self) -> PluginHandle
fn clone(&self) -> PluginHandle
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for PluginHandle
impl RefUnwindSafe for PluginHandle
impl Send for PluginHandle
impl Sync for PluginHandle
impl Unpin for PluginHandle
impl UnwindSafe for PluginHandle
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§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.