fx

Documentation

Index

• type Effect
  • func FromInvocation(invocation invocation.Invocation) Effect
  • func FromLink(link ucan.Link) Effect
  • func (e Effect) Invocation() (invocation.Invocation, bool)
  • func (e Effect) Link() ucan.Link
• type Effects
  • func NewEffects(opts ...Option) Effects
• type Option
  • func WithFork(forks ...Effect) Option
  • func WithJoin(join Effect) Option

Types

type Effect

type Effect struct {
	// contains filtered or unexported fields
}

Effect is either an invocation or a link to one.

func FromInvocation

func FromInvocation(invocation invocation.Invocation) Effect

func FromLink

func FromLink(link ucan.Link) Effect

func (Effect) Invocation

func (e Effect) Invocation() (invocation.Invocation, bool)

Invocation returns the invocation if it is available.

func (Effect) Link

func (e Effect) Link() ucan.Link

Link returns the invocation root link.

type Effects

type Effects interface {
	Fork() []Effect
	Join() Effect
}

func NewEffects

func NewEffects(opts ...Option) Effects

type Option

type Option func(fx *effects) error

Option is an option configuring effects.

func WithFork

func WithFork(forks ...Effect) Option

WithFork configures the forks for the receipt.

func WithJoin

func WithJoin(join Effect) Option

WithJoin configures the join for the receipt.