channels

Documentation

Overview

Package channels provide some simple adapters to facilitate common read/write patterns.

Index

• func MapBetween[A, B any](src Source[A], dst Sink[B], fn MapFn[A, B]) task.Task
• type MapFn
• type Receiver
• type Sender
• type Sink
  • func NewSink[T any](c chan<- T) Sink[T]
  • func (s Sink[T]) FillFrom(recv Receiver[T]) task.Task
• type Source
  • func NewSource[T any](c <-chan T) Source[T]
  • func (s Source[T]) ForwardTo(send Sender[T]) task.Task

Functions

func MapBetween

func MapBetween[A, B any](src Source[A], dst Sink[B], fn MapFn[A, B]) task.Task

Types

type MapFn

type MapFn[A, B any] func(context.Context, A) (B, error)

type Receiver

type Receiver[T any] func() (T, error)

type Sender

type Sender[T any] func(T) error

type Sink

type Sink[T any] chan<- T

func NewSink

func NewSink[T any](c chan<- T) Sink[T]

NewSink takes a writable channel and returns a Sink, which can be used to chain common transformations fluently.

func (Sink[T]) FillFrom

func (s Sink[T]) FillFrom(recv Receiver[T]) task.Task

type Source

type Source[T any] <-chan T

func NewSource

func NewSource[T any](c <-chan T) Source[T]

NewSource takes a readable channel and returns a Source, which can be used to chain common transformations fluently.

func (Source[T]) ForwardTo

func (s Source[T]) ForwardTo(send Sender[T]) task.Task