models

Documentation

Index

• Variables
• type Item
  • func (item *Item) Expired() bool
  • func (item *Item) SetSize() error
  • func (item *Item) SizeKB() float64
  • func (item *Item) SizeMB() float64
  • func (item *Item) Touch()
  • func (item *Item) Valid() error

Variables

var (
	// ItemPool is a pool of Item values.
	ItemPool = sync.Pool{
		New: func() any {
			return &Item{}
		},
	}
)

Types

type Item

type Item struct {
	Key         string        // key of the item
	Value       any           // Value of the item
	Size        int64         // Size of the item, in bytes
	Expiration  time.Duration // Expiration duration of the item
	LastAccess  time.Time     // LastAccess time of the item
	AccessCount uint          // AccessCount of times the item has been accessed
}

Item is a struct that represents an item in the cache. It has a key, value, expiration duration, and a last access time field.

func (*Item) Expired

func (item *Item) Expired() bool

Expired returns true if the item has expired, false otherwise.

func (*Item) SetSize

func (item *Item) SetSize() error

SetSize stores the size of the Item in bytes

func (*Item) SizeKB

func (item *Item) SizeKB() float64

SizeKB returns the size of the Item in kilobytes

func (*Item) SizeMB

func (item *Item) SizeMB() float64

SizeMB returns the size of the Item in megabytes

func (*Item) Touch

func (item *Item) Touch()

Touch updates the last access time of the item and increments the access count.

func (*Item) Valid

func (item *Item) Valid() error

Valid returns an error if the item is invalid, nil otherwise.