pub struct HookEngine { /* private fields */ }Expand description
Resolves configured hooks for a lifecycle phase-event.
Implementations§
Source§impl HookEngine
impl HookEngine
Sourcepub fn new(config: &HooksConfig) -> Self
pub fn new(config: &HooksConfig) -> Self
Creates a hook engine from validated hook configuration.
Sourcepub fn resolve_phase_event(
&self,
phase_event: HookPhaseEvent,
) -> Vec<ResolvedHookSpec>
pub fn resolve_phase_event( &self, phase_event: HookPhaseEvent, ) -> Vec<ResolvedHookSpec>
Resolves hooks for a canonical phase-event key in declaration order.
Sourcepub fn resolve_phase_event_str(
&self,
phase_event: &str,
) -> Vec<ResolvedHookSpec>
pub fn resolve_phase_event_str( &self, phase_event: &str, ) -> Vec<ResolvedHookSpec>
Resolves hooks by phase-event string key.
Unknown phase-event keys return an empty list.
Sourcepub fn build_payload(
&self,
phase_event: HookPhaseEvent,
input: HookPayloadBuilderInput,
) -> HookInvocationPayload
pub fn build_payload( &self, phase_event: HookPhaseEvent, input: HookPayloadBuilderInput, ) -> HookInvocationPayload
Builds the lifecycle JSON payload sent to hook stdin.
Sourcepub fn build_payload_with_timestamp(
&self,
phase_event: HookPhaseEvent,
input: HookPayloadBuilderInput,
timestamp: DateTime<Utc>,
) -> HookInvocationPayload
pub fn build_payload_with_timestamp( &self, phase_event: HookPhaseEvent, input: HookPayloadBuilderInput, timestamp: DateTime<Utc>, ) -> HookInvocationPayload
Builds the lifecycle JSON payload sent to hook stdin with a fixed timestamp.
Trait Implementations§
Source§impl Clone for HookEngine
impl Clone for HookEngine
Source§fn clone(&self) -> HookEngine
fn clone(&self) -> HookEngine
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 HookEngine
impl RefUnwindSafe for HookEngine
impl Send for HookEngine
impl Sync for HookEngine
impl Unpin for HookEngine
impl UnsafeUnpin for HookEngine
impl UnwindSafe for HookEngine
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