Struct simics::api::simulator::hap_consumer::haps::UiRunStateChangedHap
source · pub struct UiRunStateChangedHap {}
Expand description
Index: Indices not supported Description: Triggered when the run state changes; not triggered in batch mode. The argument is one of: Automatically generated struct for the HAP
Implementations§
source§impl UiRunStateChangedHap
impl UiRunStateChangedHap
sourcepub fn add_callback<F>(callback: F) -> Result<HapHandle>
pub fn add_callback<F>(callback: F) -> Result<HapHandle>
Add a callback to be called on each occurrence of this HAP. The callback may capture its environment.
§Arguments
callback
- The closure to fire as a callback. The closure will be doubly boxed. Any program state accessed inside the closure must have the static lifetime. This is not enforced by the compiler, it is up to the programmer to ensure the soundness of their callback code.
sourcepub fn add_callback_object<F>(
callback: F,
obj: *mut ConfObject,
) -> Result<HapHandle>
pub fn add_callback_object<F>( callback: F, obj: *mut ConfObject, ) -> Result<HapHandle>
Add a callback to be called on each occurrence of this HAP for a specific object. The callback may capture its environment.
§Arguments
callback
- The closure to fire as a callback. The closure will be doubly boxed. Any program state accessed inside the closure must have the static lifetime. This is not enforced by the compiler, it is up to the programmer to ensure the soundness of their callback code.obj
- The object to fire this callback for. This HAP will not trigger the callback when firing on any object other than this one.
Trait Implementations§
source§impl Hap for UiRunStateChangedHap
impl Hap for UiRunStateChangedHap
source§type Name = &'static [u8]
type Name = &'static [u8]
The type of the name of the HAP, must be convertible to raw C string to pass to
the simulator
source§fn delete_callback_id(handle: HapHandle) -> Result<()>
fn delete_callback_id(handle: HapHandle) -> Result<()>
A callback for a hap can be deleted by its handle
source§fn delete_callback_obj_id(obj: *mut ConfObject, handle: HapHandle) -> Result<()>
fn delete_callback_obj_id(obj: *mut ConfObject, handle: HapHandle) -> Result<()>
A callback for a hap can be deleted by the object it is associated with
Auto Trait Implementations§
impl Freeze for UiRunStateChangedHap
impl RefUnwindSafe for UiRunStateChangedHap
impl Send for UiRunStateChangedHap
impl Sync for UiRunStateChangedHap
impl Unpin for UiRunStateChangedHap
impl UnwindSafe for UiRunStateChangedHap
Blanket Implementations§
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