rand

Documentation

Overview

Package rand implements cancelable reads from a cryptographically safe random number source.

Index

• Variables
• func Read(b []byte) (int, error)
• func ReadContext(ctx context.Context, b []byte) (int, error)
• type ContextReader
  • func DefaultReaderWithContext(ctx context.Context) ContextReader

Variables

var Reader = DefaultReaderWithContext(context.Background())

Reader is a cryptographically safe random number source.

Functions

func Read

func Read(b []byte) (int, error)

Read blockingly reads from a random number source.

func ReadContext

func ReadContext(ctx context.Context, b []byte) (int, error)

ReadContext is a context-aware reader for random numbers.

Types

type ContextReader

type ContextReader interface {
	// Read behaves like a blocking io.Reader.Read.
	//
	// Read wraps ReadContext with a background context.
	Read(b []byte) (n int, err error)

	// ReadContext is an io.Reader that blocks until data is available or
	// until ctx is done.
	ReadContext(ctx context.Context, b []byte) (n int, err error)
}

ContextReader is a cancelable io.Reader.

func DefaultReaderWithContext

func DefaultReaderWithContext(ctx context.Context) ContextReader

DefaultReaderWithContext returns a context-aware io.Reader.

Because this stores the context, only use this in situations where an io.Reader is unavoidable.