register

Documentation

Overview

Package register implements a write-once register.

Index

• type WriteOnce
  • func (w *WriteOnce[T]) Read() T
  • func (w *WriteOnce[T]) TryWrite(val T) bool
  • func (w *WriteOnce[T]) Write(val T)

Types

type WriteOnce

type WriteOnce[T any] struct {
	// contains filtered or unexported fields
}

WriteOnce is a concurrent write-once register.

func (*WriteOnce[T]) Read

func (w *WriteOnce[T]) Read() T

Read returns the value of the register, blocking until it is written.

func (*WriteOnce[T]) TryWrite

func (w *WriteOnce[T]) TryWrite(val T) bool

TryWrite tries to write to the register and returns if the write succeeds.

func (*WriteOnce[T]) Write

func (w *WriteOnce[T]) Write(val T)

Write writes to the register, or panics if the register was already written.