cchan

Documentation

Index

• type Chan
  • func (c Chan[T]) Recv(ctx context.Context) (T, bool, error)
  • func (c Chan[T]) RecvTimeout(ctx context.Context, timeout time.Duration) (T, bool, error)
  • func (c Chan[T]) Send(ctx context.Context, v T) error
  • func (c Chan[T]) SendTimeout(ctx context.Context, v T, timeout time.Duration) error
• type ChanIn
  • func (c ChanIn[T]) Send(ctx context.Context, v T) error
  • func (c ChanIn[T]) SendTimeout(ctx context.Context, v T, timeout time.Duration) error
• type ChanOut
  • func (c ChanOut[T]) Recv(ctx context.Context) (T, bool, error)
  • func (c ChanOut[T]) RecvTimeout(ctx context.Context, timeout time.Duration) (T, bool, error)

Types

type Chan

type Chan[T any] chan T

Chan is a channel with utility methods.

func (Chan[T]) Recv

func (c Chan[T]) Recv(ctx context.Context) (T, bool, error)

Recv will try to receive a value from the channel, same as <-c. If the context is canceled before a value is received, it will return the context error.

func (Chan[T]) RecvTimeout

func (c Chan[T]) RecvTimeout(ctx context.Context, timeout time.Duration) (T, bool, error)

RecvTimeout will try to receive a value from the channel, same as <-c. If the context is canceled before a value is received or the timeout is reached, it will return the context error.

func (Chan[T]) Send

func (c Chan[T]) Send(ctx context.Context, v T) error

Send will try to send a value to the channel, same as c<-v. If the context is canceled before a value is sent, it will return the context error.

func (Chan[T]) SendTimeout

func (c Chan[T]) SendTimeout(ctx context.Context, v T, timeout time.Duration) error

SendTimeout will try to send a value to the channel, same as c<-v. If the context is canceled before a value is sent or the timeout is reached, it will return the context error.

type ChanIn

type ChanIn[T any] chan<- T

ChanIn is an input channel with utility methods.

func (ChanIn[T]) Send

func (c ChanIn[T]) Send(ctx context.Context, v T) error

Send will try to send a value to the channel, same as c<-v. If the context is canceled before a value is sent, it will return the context error.

func (ChanIn[T]) SendTimeout

func (c ChanIn[T]) SendTimeout(ctx context.Context, v T, timeout time.Duration) error

SendTimeout will try to send a value to the channel, same as c<-v. If the context is canceled before a value is sent or the timeout is reached, it will return the context error.

type ChanOut

type ChanOut[T any] <-chan T

ChanOut is an output channel with utility methods.

func (ChanOut[T]) Recv

func (c ChanOut[T]) Recv(ctx context.Context) (T, bool, error)

Recv will try to receive a value from the channel, same as <-c. If the context is canceled before a value is received, it will return the context error.

func (ChanOut[T]) RecvTimeout

func (c ChanOut[T]) RecvTimeout(ctx context.Context, timeout time.Duration) (T, bool, error)

RecvTimeout will try to receive a value from the channel, same as <-c. If the context is canceled before a value is received or the timeout is reached, it will return the context error.