safe

Documentation

Overview

package safe provides a thread-safe holder for a value that may be updated by multiple goroutines.

Index

• type Safe
  • func New(value interface{}) *Safe
  • func (s *Safe) Get() interface{}
  • func (s *Safe) GetWhenDefined() interface{}
  • func (s *Safe) Put(value interface{})

Types

type Safe

type Safe struct {
	// contains filtered or unexported fields
}

Safe contains a thread-safe value, also allowing getters to wait until the value is non-nil.

func New

func New(value interface{}) *Safe

New create a new Safe instance given a value

func (*Safe) Get

func (s *Safe) Get() interface{}

Get returns the value, even if nil.

func (*Safe) GetWhenDefined

func (s *Safe) GetWhenDefined() interface{}

GetWhenDefined returns the value, waiting until the value is not nil.

func (*Safe) Put

func (s *Safe) Put(value interface{})

Put sets a new value, which may be nil. If non-nil, any getters waiting via GetWhenDefined will wake up with the new value.