storage

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package storage はOriginごとのWeb Storage data modelを提供する。

Index

Constants

View Source
const (
	MaxKeyBytes            = 4 * 1024
	MaxValueBytes          = 1024 * 1024
	MaxOriginStorageBytes  = 5 * 1024 * 1024
	MaxProfileStorageBytes = 50 * 1024 * 1024
	MaxStorageOrigins      = 128
)

Variables

View Source
var (
	ErrQuotaExceeded = errors.New("storage quota exceeded")
	ErrInvalidString = errors.New("invalid storage string")
)
View Source
var (
	ErrSchemaMismatch = errors.New("storage schema mismatch")
	ErrCorruptData    = errors.New("corrupt storage data")
	ErrStorageIO      = errors.New("storage I/O failure")
)
View Source
var ErrInvalidOrigin = errors.New("invalid storage origin")

Functions

func DefaultDataRoot

func DefaultDataRoot() (string, error)

DefaultDataRoot はOS標準のUser Config Directory配下にGrowse data rootを返す。

func ValidateKey

func ValidateKey(key string) error

ValidateKey はWeb Storage keyのUTF-8とsize上限を検証する。

Types

type Area

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

Area は挿入順を保持する1つのStorage namespaceである。

func NewArea

func NewArea() *Area

NewArea は空のStorage Areaを生成する。

func NewFailedArea

func NewFailedArea(err error) *Area

NewFailedArea は初期化Errorを各操作から返す利用不能なAreaを生成する。

func (*Area) Clear

func (area *Area) Clear() error

Clear はすべてのentryを削除する。

func (*Area) ClearFrom added in v0.10.0

func (area *Area) ClearFrom(source MutationSource) error

ClearFrom removes every key and notifies other pages after commit.

func (*Area) Error

func (area *Area) Error() error

Error はArea初期化時のErrorを返す。

func (*Area) Get

func (area *Area) Get(key string) (string, bool)

Get はkeyのvalueと存在有無を返す。

func (*Area) Key

func (area *Area) Key(index int) (string, bool)

Key は挿入順indexのkeyを返す。

func (*Area) Len

func (area *Area) Len() int

Len はentry数を返す。

func (*Area) Remove

func (area *Area) Remove(key string) error

Remove はkeyが存在する場合に削除する。

func (*Area) RemoveFrom added in v0.10.0

func (area *Area) RemoveFrom(source MutationSource, key string) error

RemoveFrom deletes a key and notifies other pages after commit.

func (*Area) Set

func (area *Area) Set(key, value string) error

Set はkeyのvalueを追加または更新する。

func (*Area) SetFrom added in v0.10.0

func (area *Area) SetFrom(source MutationSource, key, value string) error

SetFrom adds or updates a key and notifies other pages after commit.

func (*Area) Subscribe added in v0.10.0

func (area *Area) Subscribe(sourceID uint64, notify func(Change)) func()

Subscribe registers a page for changes made by other sources. The returned function is idempotent and stops future delivery.

type Change added in v0.10.0

type Change struct {
	Key         string
	OldValue    string
	NewValue    string
	HasOldValue bool
	HasNewValue bool
	Cleared     bool
	SourceURL   string
	Sequence    uint64
}

Change describes one successfully committed Storage mutation.

type Entry

type Entry struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

Entry は永続化可能な挿入順key/valueである。

type Manager

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

Manager は1つのBrowser Windowに属するLocal / Session Storageを保持する。

func NewManager

func NewManager() *Manager

NewManager は永続化しない空のStorage Managerを生成する。

func NewPersistentManager

func NewPersistentManager(dataRoot string) (*Manager, error)

NewPersistentManager はdataRoot配下へLocal Storageを永続化するManagerを生成する。

func (*Manager) Areas

func (manager *Manager) Areas(documentURL *url.URL) (local, session *Area, err error)

Areas はDocument Originに対応するLocal / Session Storageを返す。

func (*Manager) DiscardSession added in v0.10.0

func (manager *Manager) DiscardSession()

DiscardSession destroys this top-level tab's Session Storage namespaces without affecting Local Storage shared by the browser profile.

func (*Manager) NewPageSession added in v0.10.0

func (manager *Manager) NewPageSession() *Manager

NewPageSession shares Local Storage while creating an empty Session Storage namespace for one top-level tab.

type MutationSource added in v0.10.0

type MutationSource struct {
	ID  uint64
	URL string
}

MutationSource identifies the page that changed a Local Storage Area.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL