event

Documentation

Overview

Package event exposes a single exported `Context` type that may be used to influence the execution flow of events that occur on a server. Generally, the caller of `event.C()` calls `Context.Cancelled()` to check if the `Context` was cancelled (using `Context.Cancel()`) by whatever code it was passed to. who is then able to cancel it by calling `Context.Cancel()`.

Index

• type Context
  • func C[T any](v T) *Context[T]
  • func (ctx *Context[T]) Cancel()
  • func (ctx *Context[T]) Cancelled() bool
  • func (ctx *Context[T]) Val() T

Types

type Context

type Context[T any] struct {
	// contains filtered or unexported fields
}

Context represents the context of an event. Handlers of an event may call methods on the context to change the result of the event.

func C

func C[T any](v T) *Context[T]

C returns a new event context.

func (*Context[T]) Cancel

func (ctx *Context[T]) Cancel()

Cancel cancels the context.

func (*Context[T]) Cancelled

func (ctx *Context[T]) Cancelled() bool

Cancelled returns whether the context has been cancelled.

func (*Context[T]) Val

func (ctx *Context[T]) Val() T

Val returns the subject of the Context.