package lifecycle

Import Path
	go.uber.org/fx/internal/lifecycle (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	    lifecycle.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type Callable (interface)
		A Callable is a constraint that matches functions that are, or can be
		converted to, functions suitable for a Hook.
		
		Callable must be identical to [fx.HookFunc].

	 type ContextErrorFunc = (func)
		A ContextErrorFunc is used as a [Hook.OnStart] or [Hook.OnStop]
		function.

	 type ContextFunc = (func)
		A ContextFunc can be converted to a ContextErrorFunc.

	 type ErrorFunc = (func)
		An ErrorFunc can be converted to a ContextErrorFunc.

	 type Func = (func)
		A Func can be converted to a ContextErrorFunc.

	 type Hook (struct)
		A Hook is a pair of start and stop callbacks, either of which can be nil,
		plus a string identifying the supplier of the hook.

		Fields (total 4)
			OnStart func(context.Context) error
			OnStartName string
			OnStop func(context.Context) error
			OnStopName string
		As Inputs Of (at least one exported)
			func (*Lifecycle).Append(hook Hook)

	 type HookRecord (struct)
		HookRecord keeps track of each Hook's execution time, the caller that appended the Hook, and function that ran as the Hook.

		Fields (total 3)
			CallerFrame fxreflect.Frame
				// stack frame of the caller

			Func func(context.Context) error
				// function that ran as sanitized name

			Runtime time.Duration
				// how long the hook ran


	 type HookRecords ([])
		HookRecords is a Stringer wrapper of HookRecord slice.

		Methods (total 5)
			( HookRecords) Format(w fmt.State, c rune)
				Format implements fmt.Formatter to handle "%+v".

			( HookRecords) Len() int
			( HookRecords) Less(i, j int) bool
			( HookRecords) String() string
				Used for logging startup errors.

			( HookRecords) Swap(i, j int)
		Implements (at least 4)
			 HookRecords : expvar.Var
			 HookRecords : fmt.Formatter
			 HookRecords : fmt.Stringer
			 HookRecords : sort.Interface

	 type Lifecycle (struct)
		Lifecycle coordinates application lifecycle hooks.

		Methods (total 4)
			(*Lifecycle) Append(hook Hook)
				Append adds a Hook to the lifecycle.

			(*Lifecycle) RunningHookCaller() string
				RunningHookCaller returns the name of the hook that was running when a Start/Stop
				hook timed out.

			(*Lifecycle) Start(ctx context.Context) error
				Start runs all OnStart hooks, returning immediately if it encounters an
				error.

			(*Lifecycle) Stop(ctx context.Context) error
				Stop runs any OnStop hooks whose OnStart counterpart succeeded. OnStop
				hooks run in reverse order.

		As Outputs Of (at least one exported)
			func New(logger fxevent.Logger, clock fxclock.Clock) *Lifecycle


Package-Level Functions (total 2)

	 func New(logger fxevent.Logger, clock fxclock.Clock) *Lifecycle
		New constructs a new Lifecycle.

	 func Wrap[T](x T) (ContextErrorFunc, string)

		Type Parameters:
			T: Callable

		Wrap wraps x into a ContextErrorFunc suitable for a Hook.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.