channel

package

v0.4.5 Latest Latest Go to latest Published: May 11, 2023 License: MPL-2.0 Imports: 1 Imported by: 12

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/siderolabs/gen

Links

Open Source Insights

Documentation ¶

Overview ¶

Package channel provides generic operations on channels.

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RecvWithContext ¶ added in v0.4.4

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

RecvWithContext tries to receive a value from a channel which is aborted if the context is canceled.

Function returns true if the value was received, false if the context was canceled or the channel was closed.

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 ¶ added in v0.4.4

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 ¶ added in v0.4.4

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL