package onecontext

Import Path
	github.com/teivah/onecontext (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	    detach.go
	  d onecontext.go
		Package onecontext provides a mechanism to merge multiple existing contexts.

	    reset.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type DetachedContext (struct)
		DetachedContext holds the logic to detach a cancellation signal from a context.

		Methods (total 4)
			(*DetachedContext) Deadline() (time.Time, bool)
				Deadline returns a nil deadline.

			(*DetachedContext) Done() <-chan struct{}
				Done returns a cancellation signal that expires only when the context is canceled from the cancel function returned in Detach.

			(*DetachedContext) Err() error
				Err returns an error if the context is canceled from the cancel function returned in Detach.

			(*DetachedContext) Value(key interface{}) interface{}
				Value returns the value associated with the key from the original context.

		Implements (at least one exported)
			*DetachedContext : context.Context
		As Outputs Of (at least one exported)
			func Detach(ctx context.Context) (*DetachedContext, func())

	 type OneContext (struct)
		OneContext is the struct holding the context grouping logic.

		Methods (total 4)
			(*OneContext) Deadline() (time.Time, bool)
				Deadline returns the minimum deadline among all the contexts.

			(*OneContext) Done() <-chan struct{}
				Done returns a channel for cancellation.

			(*OneContext) Err() error
				Err returns the first error raised by the contexts, otherwise a nil error.

			(*OneContext) Value(key interface{}) interface{}
				Value returns the value associated with the key from one of the contexts.

		Implements (at least one exported)
			*OneContext : context.Context

	 type ResetValuesContext (struct)
		ResetValuesContext holds the logic reset the values of a context.

		Methods (total 4)
			(*ResetValuesContext) Deadline() (time.Time, bool)
				Deadline returns the original context deadline.

			(*ResetValuesContext) Done() <-chan struct{}
				Done returns the original done channel.

			(*ResetValuesContext) Err() error
				Err returns the original context error.

			(*ResetValuesContext) Value(_ interface{}) interface{}
				Value returns nil regardless of the key.

		Implements (at least one exported)
			*ResetValuesContext : context.Context
		As Outputs Of (at least one exported)
			func ResetValues(ctx context.Context) *ResetValuesContext


Package-Level Functions (total 3)

	 func Detach(ctx context.Context) (*DetachedContext, func())
		Detach detaches the cancellation signal from a context.

	 func Merge(ctx context.Context, ctxs ...context.Context) (context.Context, context.CancelFunc)
		Merge allows to merge multiple contexts.
		It returns the merged context and a CancelFunc to cancel it.

	 func ResetValues(ctx context.Context) *ResetValuesContext
		ResetValues reset the values of a context.


Package-Level Variables (only one)

	  var ErrCanceled error
		ErrCanceled is the returned when the CancelFunc returned by Merge is called.

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.