channel

Documentation

Overview

Package channel provides generic operations on channels.

Index

• func SendWithContext[T any](ctx context.Context, ch chan<- T, val T) bool
• type RecvState
  • func TryRecv[T any](ch <-chan T) (T, RecvState)

Functions

func SendWithContext

func SendWithContext[T any](ctx context.Context, ch chan<- T, val T) bool

SendWithContext tries to send a value to a channel which is aborted if the context is canceled.

Function returns true if the value was sent, false if the context was canceled.

Types

type RecvState

type RecvState int

RecvState is the state of a channel after receiving a value.

const (
	// StateRecv means that a value was received from the channel.
	StateRecv RecvState = iota
	// StateEmpty means that the channel was empty.
	StateEmpty
	// StateClosed means that the channel was closed.
	StateClosed
)

func TryRecv

func TryRecv[T any](ch <-chan T) (T, RecvState)

TryRecv tries to receive a value from a channel.

Function returns the value and the state of the channel.