safe

Documentation

Index

• type Int
  • func NewInt() *Int
  • func (i *Int) Dec(step int)
  • func (i *Int) Get() int
  • func (i *Int) Inc(step int)
  • func (i *Int) MarshalJSON() ([]byte, error)
  • func (i *Int) Set(value int)
  • func (i *Int) String() string
  • func (i *Int) UnmarshalJSON(data []byte) error
• type Int64
  • func NewInt64() *Int64
  • func (i *Int64) Dec(step int64)
  • func (i *Int64) Get() int64
  • func (i *Int64) Inc(step int64)
  • func (i *Int64) MarshalJSON() ([]byte, error)
  • func (i *Int64) Set(value int64)
  • func (i *Int64) String() string
  • func (i *Int64) UnmarshalJSON(data []byte) error
• type List
  • func NewList[V any](opts ...ListOption) *List[V]
  • func (l *List[V]) Clear()
  • func (l *List[V]) Contains(value V) bool
  • func (l *List[V]) Filter(f func(V) bool) *List[V]
  • func (l *List[V]) Find(f func(V) bool) V
  • func (l *List[V]) First() V
  • func (l *List[V]) ForEach(f func(V) (stop bool))
  • func (l *List[V]) Get(index int) V
  • func (l *List[V]) IndexOf(value V) int
  • func (l *List[V]) Iterator() []V
  • func (l *List[V]) LPop() V
  • func (l *List[V]) LPush(value V)
  • func (l *List[V]) Last() V
  • func (l *List[V]) Length() int
  • func (l *List[V]) Map(f func(V) V) *List[V]
  • func (l *List[V]) MarshalJSON() ([]byte, error)
  • func (l *List[V]) Pop() V
  • func (l *List[V]) Push(value V)
  • func (l *List[V]) Reduce(f func(V, V) V) V
  • func (l *List[V]) Reverse() *List[V]
  • func (l *List[V]) Shift() V
  • func (l *List[V]) Size() int
  • func (l *List[V]) Slice(start int, end int) *List[V]
  • func (l *List[V]) Splice(index int, count int) *List[V]
  • func (l *List[V]) String() string
  • func (l *List[V]) Swap(index1 int, index2 int)
  • func (l *List[V]) ToSlice() []V
  • func (l *List[V]) UnmarshalJSON(data []byte) error
  • func (l *List[V]) Unshift(value V)
  • func (l *List[V]) Unshifts(values V)
• type ListConfig
• type ListOption
• type Map
  • func NewMap[K comparable, V any](opts ...MapOption) *Map[K, V]
  • func (m *Map[K, V]) Clear() error
  • func (m *Map[K, V]) Del(key K) error
  • func (m *Map[K, V]) ForEach(f func(K, V) (stop bool))
  • func (m *Map[K, V]) Get(key K) V
  • func (m *Map[K, V]) Has(key K) bool
  • func (m *Map[K, V]) Iterator() map[K]V
  • func (m *Map[K, V]) Keys() []K
  • func (m *Map[K, V]) MarshalJSON() ([]byte, error)
  • func (m *Map[K, V]) Set(key K, value V) error
  • func (m *Map[K, V]) String() string
  • func (m *Map[K, V]) ToMap() map[K]V
  • func (m *Map[K, V]) UnmarshalJSON(data []byte) error
• type MapConfig
• type MapOption
• type Queue
  • func NewQueue[V any](opts ...QueueOption) *Queue[V]
  • func (q *Queue[V]) Back() V
  • func (q *Queue[V]) Clear()
  • func (q *Queue[V]) Dequeue() V
  • func (q *Queue[V]) Enqueue(value V)
  • func (q *Queue[V]) ForEach(fn func(value V, index int) (stop bool))
  • func (q *Queue[V]) ForEachReverse(fn func(value V, index int) (stop bool))
  • func (q *Queue[V]) Front() V
  • func (q *Queue[V]) IsEmpty() bool
  • func (q *Queue[V]) MarshalJSON() ([]byte, error)
  • func (q *Queue[V]) Size() int
  • func (q *Queue[V]) String() string
  • func (q *Queue[V]) ToSlice() []V
  • func (q *Queue[V]) UnmarshalJSON(data []byte) error
• type QueueConfig
• type QueueOption
• type Stack
  • func NewStack[V any]() *Stack[V]
  • func (m *Stack[V]) Clear(key string)
  • func (m *Stack[V]) ForEach(key string, fn func(value V, index int) (stop bool))
  • func (m *Stack[V]) ForEachReverse(key string, fn func(value V, index int) (stop bool))
  • func (m *Stack[V]) IsEmpty(key string) bool
  • func (m *Stack[V]) MarshalJSON() ([]byte, error)
  • func (m *Stack[V]) Peek(key string) V
  • func (m *Stack[V]) Pop(key string) V
  • func (m *Stack[V]) Push(key string, value V)
  • func (m *Stack[V]) Size(key string) int
  • func (m *Stack[V]) String() string
  • func (m *Stack[V]) ToSlice(key string) []V
  • func (m *Stack[V]) UnmarshalJSON(data []byte) error
• type String
  • func NewString() *String
  • func (i *String) Get() string
  • func (i *String) Set(value string)

Types

type Int

type Int struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Int ...

func NewInt

func NewInt() *Int

NewInt returns a new safe int

func (*Int) Dec

func (i *Int) Dec(step int)

Dec decrements the int by step

func (*Int) Get

func (i *Int) Get() int

Get returns the int

func (*Int) Inc

func (i *Int) Inc(step int)

Inc increments the int by step

func (*Int) MarshalJSON

func (i *Int) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the int

func (*Int) Set

func (i *Int) Set(value int)

Set sets the int to the given value

func (*Int) String

func (i *Int) String() string

String returns the string representation of the int

func (*Int) UnmarshalJSON

func (i *Int) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the JSON-encoded data and stores the result in the int

type Int64

type Int64 struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Int64 ...

func NewInt64

func NewInt64() *Int64

NewInt64 returns a new safe int

func (*Int64) Dec

func (i *Int64) Dec(step int64)

Dec decrements the int by step

func (*Int64) Get

func (i *Int64) Get() int64

Get returns the int

func (*Int64) Inc

func (i *Int64) Inc(step int64)

Inc increments the int by step

func (*Int64) MarshalJSON

func (i *Int64) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the int

func (*Int64) Set

func (i *Int64) Set(value int64)

Set sets the int to the given value

func (*Int64) String

func (i *Int64) String() string

String returns the string representation of the int

func (*Int64) UnmarshalJSON

func (i *Int64) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the JSON-encoded data and stores the result in the int

type List

type List[V any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

List ...

func NewList

func NewList[V any](opts ...ListOption) *List[V]

NewList returns a new safe list

@TODO generic type comparable interface cannot implement by struct，so we use any type for generic type

func (*List[V]) Clear

func (l *List[V]) Clear()

Clear removes all elements from the list

func (*List[V]) Contains

func (l *List[V]) Contains(value V) bool

Contains returns true if the list contains the given element

func (*List[V]) Filter

func (l *List[V]) Filter(f func(V) bool) *List[V]

Filter returns a new list with all elements that satisfy the given function

func (*List[V]) Find

func (l *List[V]) Find(f func(V) bool) V

Find returns the first element that satisfies the given function

func (*List[V]) First

func (l *List[V]) First() V

First returns the first element of the list

func (*List[V]) ForEach

func (l *List[V]) ForEach(f func(V) (stop bool))

ForEach iterates over the list and calls the given function for each element

func (*List[V]) Get

func (l *List[V]) Get(index int) V

Get returns the element at the given index

func (*List[V]) IndexOf

func (l *List[V]) IndexOf(value V) int

IndexOf returns the index of the given element

func (*List[V]) Iterator

func (l *List[V]) Iterator() []V

Iterator returns a channel that will yield successive elements of the list

func (*List[V]) LPop

func (l *List[V]) LPop() V

LPop removes and returns the first element of the list

func (*List[V]) LPush

func (l *List[V]) LPush(value V)

LPush adds an element to the beginning of the list

func (*List[V]) Last

func (l *List[V]) Last() V

Last returns the last element of the list

func (*List[V]) Length

func (l *List[V]) Length() int

Length is an alias of Size

func (*List[V]) Map

func (l *List[V]) Map(f func(V) V) *List[V]

Map returns a new list with the result of calling the given function on each element

func (*List[V]) MarshalJSON

func (l *List[V]) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the list

func (*List[V]) Pop

func (l *List[V]) Pop() V

Pop removes and returns the last element of the list

func (*List[V]) Push

func (l *List[V]) Push(value V)

Push adds an element to the end of the list

func (*List[V]) Reduce

func (l *List[V]) Reduce(f func(V, V) V) V

Reduce returns the result of reducing the list to a single value

func (*List[V]) Reverse

func (l *List[V]) Reverse() *List[V]

Reverse reverses the list

func (*List[V]) Shift

func (l *List[V]) Shift() V

Shift removes and returns the first element of the list

like JavaScript Array.shift

func (*List[V]) Size

func (l *List[V]) Size() int

Size returns the number of elements in the list

func (*List[V]) Slice

func (l *List[V]) Slice(start int, end int) *List[V]

Slice returns a new list with a copy of a given number of elements from the given index

func (*List[V]) Splice

func (l *List[V]) Splice(index int, count int) *List[V]

Splice removes the given number of elements from the given index

func (*List[V]) String

func (l *List[V]) String() string

String returns the string representation of the list

func (*List[V]) Swap

func (l *List[V]) Swap(index1 int, index2 int)

Swap swaps the elements at the given indices

func (*List[V]) ToSlice

func (l *List[V]) ToSlice() []V

ToSlice returns the origin map

func (*List[V]) UnmarshalJSON

func (l *List[V]) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the JSON-encoded data and stores the result in the list

func (*List[V]) Unshift

func (l *List[V]) Unshift(value V)

Unshift adds an element to the beginning of the list

func (*List[V]) Unshifts

func (l *List[V]) Unshifts(values V)

Unshift adds an element to the beginning of the list

like JavaScript Array.unshift

type ListConfig

type ListConfig struct {
	Capacity int
}

ListConfig ...

type ListOption

type ListOption func(*ListConfig)

ListOption ...

type Map

type Map[K comparable, V any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Map ...

func NewMap

func NewMap[K comparable, V any](opts ...MapOption) *Map[K, V]

NewMap returns a new safe map

func (*Map[K, V]) Clear

func (m *Map[K, V]) Clear() error

Clear removes all elements from the map

func (*Map[K, V]) Del

func (m *Map[K, V]) Del(key K) error

Del deletes a key from the map

func (*Map[K, V]) ForEach

func (m *Map[K, V]) ForEach(f func(K, V) (stop bool))

ForEach iterates over the map and calls the given function for each key and value

func (*Map[K, V]) Get

func (m *Map[K, V]) Get(key K) V

Get returns the value for a key

func (*Map[K, V]) Has

func (m *Map[K, V]) Has(key K) bool

Has returns true if the map contains the key

func (*Map[K, V]) Iterator

func (m *Map[K, V]) Iterator() map[K]V

Iterator returns a channel that will yield all the keys and values in the map

func (*Map[K, V]) Keys

func (m *Map[K, V]) Keys() []K

Keys returns all the keys in the map

func (*Map[K, V]) MarshalJSON

func (m *Map[K, V]) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the map

func (*Map[K, V]) Set

func (m *Map[K, V]) Set(key K, value V) error

Set sets a key = value in the map

func (*Map[K, V]) String

func (m *Map[K, V]) String() string

String returns the string representation of the map

func (*Map[K, V]) ToMap

func (m *Map[K, V]) ToMap() map[K]V

ToMap returns the origin map

func (*Map[K, V]) UnmarshalJSON

func (m *Map[K, V]) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the JSON encoding of the map

type MapConfig

type MapConfig struct {
	Capacity int
}

MapConfig ...

type MapOption

type MapOption func(*MapConfig)

MapOption ...

type Queue

type Queue[V any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Queue ...

func NewQueue

func NewQueue[V any](opts ...QueueOption) *Queue[V]

NewQueue returns a new safe queue

func (*Queue[V]) Back

func (q *Queue[V]) Back() V

Back returns the last element of the queue

func (*Queue[V]) Clear

func (q *Queue[V]) Clear()

Clear removes all elements from the queue

func (*Queue[V]) Dequeue

func (q *Queue[V]) Dequeue() V

Dequeue removes and returns the first element of the queue

func (*Queue[V]) Enqueue

func (q *Queue[V]) Enqueue(value V)

Enqueue adds an element to the end of the queue

func (*Queue[V]) ForEach

func (q *Queue[V]) ForEach(fn func(value V, index int) (stop bool))

ForEach iterates over the queue and calls the given function for each element from front to back

func (*Queue[V]) ForEachReverse

func (q *Queue[V]) ForEachReverse(fn func(value V, index int) (stop bool))

ForEachReverse iterates over the queue and calls the given function for each element from back to front

func (*Queue[V]) Front

func (q *Queue[V]) Front() V

Front returns the first element of the queue

func (*Queue[V]) IsEmpty

func (q *Queue[V]) IsEmpty() bool

IsEmpty returns true if the queue is empty

func (*Queue[V]) MarshalJSON

func (q *Queue[V]) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the queue

func (*Queue[V]) Size

func (q *Queue[V]) Size() int

Size returns the number of elements in the queue

func (*Queue[V]) String

func (q *Queue[V]) String() string

String returns a string representation of the queue

func (*Queue[V]) ToSlice

func (q *Queue[V]) ToSlice() []V

ToSlice returns the origin queue

func (*Queue[V]) UnmarshalJSON

func (q *Queue[V]) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the JSON encoding of the queue

type QueueConfig

type QueueConfig struct {
	Capacity int
}

QueueConfig ...

type QueueOption

type QueueOption func(*QueueConfig)

QueueOption ...

type Stack

type Stack[V any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Stack ...

func NewStack

func NewStack[V any]() *Stack[V]

NewStack returns a new safe stack

func (*Stack[V]) Clear

func (m *Stack[V]) Clear(key string)

Clear removes all elements from the stack

func (*Stack[V]) ForEach

func (m *Stack[V]) ForEach(key string, fn func(value V, index int) (stop bool))

ForEach iterates over the stack, calling the given function for each element from top to bottom

func (*Stack[V]) ForEachReverse

func (m *Stack[V]) ForEachReverse(key string, fn func(value V, index int) (stop bool))

ForEachReverse iterates over the stack, calling the given function for each element from bottom to top

func (*Stack[V]) IsEmpty

func (m *Stack[V]) IsEmpty(key string) bool

IsEmpty returns true if the stack is empty

func (*Stack[V]) MarshalJSON

func (m *Stack[V]) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the stack

func (*Stack[V]) Peek

func (m *Stack[V]) Peek(key string) V

Peek returns the last element of the stack

func (*Stack[V]) Pop

func (m *Stack[V]) Pop(key string) V

Pop removes and returns the last element of the stack

func (*Stack[V]) Push

func (m *Stack[V]) Push(key string, value V)

Push adds an element to the end of the stack

func (*Stack[V]) Size

func (m *Stack[V]) Size(key string) int

Size returns the number of elements in the stack

func (*Stack[V]) String

func (m *Stack[V]) String() string

String returns a string representation of the stack

func (*Stack[V]) ToSlice

func (m *Stack[V]) ToSlice(key string) []V

ToSlice returns the origin stack

func (*Stack[V]) UnmarshalJSON

func (m *Stack[V]) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the JSON encoding of the stack

type String

type String struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

String ...

func NewString

func NewString() *String

NewString returns a new safe string

func (*String) Get

func (i *String) Get() string

Get returns the string

func (*String) Set

func (i *String) Set(value string)

Set sets the string to the given value