RWSafe

Documentation

Index

• type Locker
  • func NewLocker[T uc.Enumer]() *Locker[T]
  • func (l *Locker[T]) ChangeValue(key T, value bool) bool
  • func (l *Locker[T]) DoFunc(f func(map[T]bool) bool) bool
  • func (l *Locker[T]) Get(key T) (bool, bool)
  • func (l *Locker[T]) SetSubject(key T, value bool, broadcast bool)
• type Observer
• type ReactiveObserver
  • func NewReactiveObserver[T any](event func(T)) *ReactiveObserver[T]
  • func (r *ReactiveObserver[T]) Notify(change T)
• type Safe
  • func NewSafe[T any](value T) *Safe[T]
  • func (s *Safe[T]) Copy() uc.Copier
  • func (s *Safe[T]) DoRead(f func(T))
  • func (s *Safe[T]) Get() T
  • func (s *Safe[T]) Modifyvalue(f func(T) T)
  • func (s *Safe[T]) Set(value T)
• type SafeMap
  • func NewSafeMap[T comparable, U any]() *SafeMap[T, U]
  • func (sm *SafeMap[T, U]) Clear()
  • func (sm *SafeMap[T, U]) Copy() uc.Copier
  • func (sm *SafeMap[T, U]) Delete(key T)
  • func (sm *SafeMap[T, U]) Get(key T) (U, bool)
  • func (sm *SafeMap[T, U]) GetMap() map[T]U
  • func (sm *SafeMap[T, U]) Iterator() uc.Iterater[uc.Pair[T, U]]
  • func (sm *SafeMap[T, U]) Len() int
  • func (sm *SafeMap[T, U]) Scan(f ScanFunc[T, U]) (bool, error)
  • func (sm *SafeMap[T, U]) Set(key T, val U)
• type ScanFunc
• type Subject
  • func NewSubject[T any](state T) *Subject[T]
  • func (s *Subject[T]) Attach(o Observer[T])
  • func (s *Subject[T]) Copy() uc.Copier
  • func (s *Subject[T]) DoRead(f func(T))
  • func (s *Subject[T]) Get() T
  • func (s *Subject[T]) ModifyState(f func(T) T)
  • func (s *Subject[T]) NotifyAll()
  • func (s *Subject[T]) Set(state T)
  • func (s *Subject[T]) SetObserver(action func(T))

Types

type Locker

type Locker[T uc.Enumer] struct {
	// contains filtered or unexported fields
}

Locker is a thread-Subject locker that allows multiple goroutines to wait for a condition.

func NewLocker

func NewLocker[T uc.Enumer]() *Locker[T]

NewLocker creates a new Locker.

Use Locker.Set for observer boolean predicates.

Parameters:

• keys: The keys to initialize the locker.

Returns:

• *Locker[T]: A new Locker.

Behaviors:

• All the predicates are initialized to true.

func (*Locker[T]) ChangeValue

func (l *Locker[T]) ChangeValue(key T, value bool) bool

ChangeValue changes the value of a subject.

Parameters:

• key: The key to change the value.
• value: The new value.

Returns:

• bool: True if the key exists, false otherwise.

func (*Locker[T]) DoFunc

func (l *Locker[T]) DoFunc(f func(map[T]bool) bool) bool

DoFunc is a function that executes a function while waiting for the condition to be false.

Parameters:

• f: The function to execute that takes a map of conditions as a parameter and returns true if the function should exit, false otherwise.

Returns:

• bool: True if the function should exit, false otherwise.

func (*Locker[T]) Get

func (l *Locker[T]) Get(key T) (bool, bool)

Get returns the value of a predicate.

Parameters:

• key: The key to get the value.

Returns:

• bool: The value of the predicate.
• bool: True if the key exists, false otherwise.

func (*Locker[T]) SetSubject

func (l *Locker[T]) SetSubject(key T, value bool, broadcast bool)

SetSubject adds a new subject to the locker.

Parameters:

• key: The key to add.
• subject: The subject to add.
• broadcast: A flag indicating whether the subject should broadcast or signal.

Behaviors:

• If the subject is nil, it will not be added.
• It overwrites the existing subject if the key already exists.

type Observer

type Observer[T any] interface {
	// Notify notifies the observer of a change.
	//
	// Parameters:
	//   - change: The change that occurred.
	Notify(change T)
}

Observer is the interface that wraps the Notify method.

type ReactiveObserver

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

ReactiveObserver is a type that acts as a simple observer that calls a function when a change occurs.

func NewReactiveObserver

func NewReactiveObserver[T any](event func(T)) *ReactiveObserver[T]

NewReactiveObserver creates a new ReactiveObserver.

Parameters:

• event: The event to call when a change occurs.

Returns:

• *ReactiveObserver[T]: A new ReactiveObserver.

func (*ReactiveObserver[T]) Notify

func (r *ReactiveObserver[T]) Notify(change T)

Notify implements the Observer interface.

type Safe

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

Safe is a rw mutex protected variable.

func NewSafe

func NewSafe[T any](value T) *Safe[T]

NewSafe creates a new safe variable.

Parameters:

• value: The value of the safe variable.

Returns:

• *Safe[T]: A new safe variable.

func (*Safe[T]) Copy

func (s *Safe[T]) Copy() uc.Copier

Copy implements the Copier interface.

func (*Safe[T]) DoRead

func (s *Safe[T]) DoRead(f func(T))

DoRead is a method of the safe variable type. It is used to perform a read operation on the value stored in the safe variable. Through the function parameter, the caller can access the value in a read-only manner.

Parameters:

• f: A function that takes a value of type T as a parameter and returns nothing.

func (*Safe[T]) Get

func (s *Safe[T]) Get() T

Get gets the value of the safe variable.

Returns:

• T: The value of the safe variable.

func (*Safe[T]) Modifyvalue

func (s *Safe[T]) Modifyvalue(f func(T) T)

Modifyvalue modifies the value of the safe variable.

Parameters:

• f: The function to modify the value of the safe variable.

func (*Safe[T]) Set

func (s *Safe[T]) Set(value T)

Set sets the value of the safe variable.

Parameters:

• value: The value to set the safe variable to.

type SafeMap

type SafeMap[T comparable, U any] struct {
	// contains filtered or unexported fields
}

SafeMap is a thread-safe map.

func NewSafeMap

func NewSafeMap[T comparable, U any]() *SafeMap[T, U]

NewSafeMap creates a new SafeMap.

Returns:

• *SafeMap[T, U]: A new SafeMap.

func (*SafeMap[T, U]) Clear

func (sm *SafeMap[T, U]) Clear()

Clear removes all elements from the map.

func (*SafeMap[T, U]) Copy

func (sm *SafeMap[T, U]) Copy() uc.Copier

Copy implements the Copier interface.

func (*SafeMap[T, U]) Delete

func (sm *SafeMap[T, U]) Delete(key T)

Delete removes a key from the map.

Parameters:

• key: The key to remove.

func (*SafeMap[T, U]) Get

func (sm *SafeMap[T, U]) Get(key T) (U, bool)

Get retrieves a value from the map.

Parameters:

• key: The key to retrieve the value.

Returns:

• U: The value associated with the key.
• bool: A boolean indicating if the key exists in the map.

func (*SafeMap[T, U]) GetMap

func (sm *SafeMap[T, U]) GetMap() map[T]U

GetMap returns the underlying map.

Returns:

• map[T]U: The underlying map.

func (*SafeMap[T, U]) Iterator

func (sm *SafeMap[T, U]) Iterator() uc.Iterater[uc.Pair[T, U]]

Iterator implements the Iterable interface.

func (*SafeMap[T, U]) Len

func (sm *SafeMap[T, U]) Len() int

Len returns the number of elements in the map.

Returns:

• int: The number of elements in the map.

func (*SafeMap[T, U]) Scan

func (sm *SafeMap[T, U]) Scan(f ScanFunc[T, U]) (bool, error)

Scan applies a read-only function to all elements in the map.

Parameters:

• f: The function to apply to all elements.

Returns:

• bool: A boolean indicating if the scan completed successfully.
• error: An error if the scan failed.

func (*SafeMap[T, U]) Set

func (sm *SafeMap[T, U]) Set(key T, val U)

Set sets a value in the map.

Parameters:

• key: The key to set the value.
• val: The value to set.

type ScanFunc

type ScanFunc[T, U any] func(key T, value U) (bool, error)

ScanFunc is a function that can be applied to all elements in the map.

Parameters:

• key: The key of the element.
• value: The value of the element.

Returns:

• bool: A boolean indicating if the scan should continue.
• error: An error if the scan should stop.

type Subject

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

Subject is the subject that observers observe.

func NewSubject

func NewSubject[T any](state T) *Subject[T]

NewSubject creates a new subject.

Parameters:

• state: The initial state of the subject.

Returns:

*Subject[T]: A new subject.

func (*Subject[T]) Attach

func (s *Subject[T]) Attach(o Observer[T])

Attach attaches an observer to the subject.

Parameters:

• o: The observer to attach.

func (*Subject[T]) Copy

func (s *Subject[T]) Copy() uc.Copier

Copy implements the Copier interface.

However, the obsevers are not copied.

func (*Subject[T]) DoRead

func (s *Subject[T]) DoRead(f func(T))

DoRead is a method of the Subject type. It is used to perform a read operation on the value stored in the Subject. Through the function parameter, the caller can access the value in a read-only manner.

Parameters:

• f: A function that takes a value of type T as a parameter and returns nothing.

func (*Subject[T]) Get

func (s *Subject[T]) Get() T

Get gets the state of the subject.

Returns:

• T: The state of the subject.

func (*Subject[T]) ModifyState

func (s *Subject[T]) ModifyState(f func(T) T)

ModifyState modifies the state of the subject.

Parameters:

• f: The function to modify the state of the subject.

func (*Subject[T]) NotifyAll

func (s *Subject[T]) NotifyAll()

NotifyAll notifies all observers of a change.

func (*Subject[T]) Set

func (s *Subject[T]) Set(state T)

Set sets the state of the subject.

Parameters:

• state: The new state of the subject.

func (*Subject[T]) SetObserver

func (s *Subject[T]) SetObserver(action func(T))

SetObserver sets the observer of the subject.

Parameters:

• action: The action to set as the observer.