cachestorage

package
v0.0.0-...-8ed5860 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2022 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package cachestorage provides the Chrome DevTools Protocol commands, types, and events for the CacheStorage domain.

Generated by the cdproto-gen command.

Index

Constants

View Source
const (
	CommandDeleteCache           = "CacheStorage.deleteCache"
	CommandDeleteEntry           = "CacheStorage.deleteEntry"
	CommandRequestCacheNames     = "CacheStorage.requestCacheNames"
	CommandRequestCachedResponse = "CacheStorage.requestCachedResponse"
	CommandRequestEntries        = "CacheStorage.requestEntries"
)

Command names.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cache

type Cache struct {
	CacheID        CacheID `json:"cacheId"`        // An opaque unique id of the cache.
	SecurityOrigin string  `json:"securityOrigin"` // Security origin of the cache.
	CacheName      string  `json:"cacheName"`      // The name of the cache.
}

Cache cache identifier.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-Cache

func (Cache) MarshalEasyJSON

func (v Cache) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Cache) MarshalJSON

func (v Cache) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Cache) UnmarshalEasyJSON

func (v *Cache) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Cache) UnmarshalJSON

func (v *Cache) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CacheID

type CacheID string

CacheID unique identifier of the Cache object.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-CacheId

func (CacheID) String

func (t CacheID) String() string

String returns the CacheID as string value.

type CachedResponse

type CachedResponse struct {
	Body string `json:"body"` // Entry content, base64-encoded.
}

CachedResponse cached response.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-CachedResponse

func (CachedResponse) MarshalEasyJSON

func (v CachedResponse) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CachedResponse) MarshalJSON

func (v CachedResponse) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CachedResponse) UnmarshalEasyJSON

func (v *CachedResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CachedResponse) UnmarshalJSON

func (v *CachedResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CachedResponseType

type CachedResponseType string

CachedResponseType type of HTTP response cached.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-CachedResponseType

const (
	CachedResponseTypeBasic          CachedResponseType = "basic"
	CachedResponseTypeCors           CachedResponseType = "cors"
	CachedResponseTypeDefault        CachedResponseType = "default"
	CachedResponseTypeError          CachedResponseType = "error"
	CachedResponseTypeOpaqueResponse CachedResponseType = "opaqueResponse"
	CachedResponseTypeOpaqueRedirect CachedResponseType = "opaqueRedirect"
)

CachedResponseType values.

func (CachedResponseType) MarshalEasyJSON

func (t CachedResponseType) MarshalEasyJSON(out *jwriter.Writer)

MarshalEasyJSON satisfies easyjson.Marshaler.

func (CachedResponseType) MarshalJSON

func (t CachedResponseType) MarshalJSON() ([]byte, error)

MarshalJSON satisfies json.Marshaler.

func (CachedResponseType) String

func (t CachedResponseType) String() string

String returns the CachedResponseType as string value.

func (*CachedResponseType) UnmarshalEasyJSON

func (t *CachedResponseType) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

func (*CachedResponseType) UnmarshalJSON

func (t *CachedResponseType) UnmarshalJSON(buf []byte) error

UnmarshalJSON satisfies json.Unmarshaler.

type DataEntry

type DataEntry struct {
	RequestURL         string             `json:"requestURL"`         // Request URL.
	RequestMethod      string             `json:"requestMethod"`      // Request method.
	RequestHeaders     []*Header          `json:"requestHeaders"`     // Request headers
	ResponseTime       float64            `json:"responseTime"`       // Number of seconds since epoch.
	ResponseStatus     int64              `json:"responseStatus"`     // HTTP response status code.
	ResponseStatusText string             `json:"responseStatusText"` // HTTP response status text.
	ResponseType       CachedResponseType `json:"responseType"`       // HTTP response type
	ResponseHeaders    []*Header          `json:"responseHeaders"`    // Response headers
}

DataEntry data entry.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-DataEntry

func (DataEntry) MarshalEasyJSON

func (v DataEntry) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (DataEntry) MarshalJSON

func (v DataEntry) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*DataEntry) UnmarshalEasyJSON

func (v *DataEntry) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DataEntry) UnmarshalJSON

func (v *DataEntry) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type DeleteCacheParams

type DeleteCacheParams struct {
	CacheID CacheID `json:"cacheId"` // Id of cache for deletion.
}

DeleteCacheParams deletes a cache.

func DeleteCache

func DeleteCache(cacheID CacheID) *DeleteCacheParams

DeleteCache deletes a cache.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#method-deleteCache

parameters:

cacheID - Id of cache for deletion.

func (*DeleteCacheParams) Do

func (p *DeleteCacheParams) Do(ctx context.Context) (err error)

Do executes CacheStorage.deleteCache against the provided context.

func (DeleteCacheParams) MarshalEasyJSON

func (v DeleteCacheParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (DeleteCacheParams) MarshalJSON

func (v DeleteCacheParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*DeleteCacheParams) UnmarshalEasyJSON

func (v *DeleteCacheParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DeleteCacheParams) UnmarshalJSON

func (v *DeleteCacheParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type DeleteEntryParams

type DeleteEntryParams struct {
	CacheID CacheID `json:"cacheId"` // Id of cache where the entry will be deleted.
	Request string  `json:"request"` // URL spec of the request.
}

DeleteEntryParams deletes a cache entry.

func DeleteEntry

func DeleteEntry(cacheID CacheID, request string) *DeleteEntryParams

DeleteEntry deletes a cache entry.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#method-deleteEntry

parameters:

cacheID - Id of cache where the entry will be deleted.
request - URL spec of the request.

func (*DeleteEntryParams) Do

func (p *DeleteEntryParams) Do(ctx context.Context) (err error)

Do executes CacheStorage.deleteEntry against the provided context.

func (DeleteEntryParams) MarshalEasyJSON

func (v DeleteEntryParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (DeleteEntryParams) MarshalJSON

func (v DeleteEntryParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*DeleteEntryParams) UnmarshalEasyJSON

func (v *DeleteEntryParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DeleteEntryParams) UnmarshalJSON

func (v *DeleteEntryParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Header struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

Header [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#type-Header

func (Header) MarshalEasyJSON

func (v Header) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Header) MarshalJSON

func (v Header) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Header) UnmarshalEasyJSON

func (v *Header) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Header) UnmarshalJSON

func (v *Header) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RequestCacheNamesParams

type RequestCacheNamesParams struct {
	SecurityOrigin string `json:"securityOrigin"` // Security origin.
}

RequestCacheNamesParams requests cache names.

func RequestCacheNames

func RequestCacheNames(securityOrigin string) *RequestCacheNamesParams

RequestCacheNames requests cache names.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#method-requestCacheNames

parameters:

securityOrigin - Security origin.

func (*RequestCacheNamesParams) Do

func (p *RequestCacheNamesParams) Do(ctx context.Context) (caches []*Cache, err error)

Do executes CacheStorage.requestCacheNames against the provided context.

returns:

caches - Caches for the security origin.

func (RequestCacheNamesParams) MarshalEasyJSON

func (v RequestCacheNamesParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestCacheNamesParams) MarshalJSON

func (v RequestCacheNamesParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestCacheNamesParams) UnmarshalEasyJSON

func (v *RequestCacheNamesParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestCacheNamesParams) UnmarshalJSON

func (v *RequestCacheNamesParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RequestCacheNamesReturns

type RequestCacheNamesReturns struct {
	Caches []*Cache `json:"caches,omitempty"` // Caches for the security origin.
}

RequestCacheNamesReturns return values.

func (RequestCacheNamesReturns) MarshalEasyJSON

func (v RequestCacheNamesReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestCacheNamesReturns) MarshalJSON

func (v RequestCacheNamesReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestCacheNamesReturns) UnmarshalEasyJSON

func (v *RequestCacheNamesReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestCacheNamesReturns) UnmarshalJSON

func (v *RequestCacheNamesReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RequestCachedResponseParams

type RequestCachedResponseParams struct {
	CacheID        CacheID   `json:"cacheId"`        // Id of cache that contains the entry.
	RequestURL     string    `json:"requestURL"`     // URL spec of the request.
	RequestHeaders []*Header `json:"requestHeaders"` // headers of the request.
}

RequestCachedResponseParams fetches cache entry.

func RequestCachedResponse

func RequestCachedResponse(cacheID CacheID, requestURL string, requestHeaders []*Header) *RequestCachedResponseParams

RequestCachedResponse fetches cache entry.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#method-requestCachedResponse

parameters:

cacheID - Id of cache that contains the entry.
requestURL - URL spec of the request.
requestHeaders - headers of the request.

func (*RequestCachedResponseParams) Do

func (p *RequestCachedResponseParams) Do(ctx context.Context) (response *CachedResponse, err error)

Do executes CacheStorage.requestCachedResponse against the provided context.

returns:

response - Response read from the cache.

func (RequestCachedResponseParams) MarshalEasyJSON

func (v RequestCachedResponseParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestCachedResponseParams) MarshalJSON

func (v RequestCachedResponseParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestCachedResponseParams) UnmarshalEasyJSON

func (v *RequestCachedResponseParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestCachedResponseParams) UnmarshalJSON

func (v *RequestCachedResponseParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RequestCachedResponseReturns

type RequestCachedResponseReturns struct {
	Response *CachedResponse `json:"response,omitempty"` // Response read from the cache.
}

RequestCachedResponseReturns return values.

func (RequestCachedResponseReturns) MarshalEasyJSON

func (v RequestCachedResponseReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestCachedResponseReturns) MarshalJSON

func (v RequestCachedResponseReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestCachedResponseReturns) UnmarshalEasyJSON

func (v *RequestCachedResponseReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestCachedResponseReturns) UnmarshalJSON

func (v *RequestCachedResponseReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RequestEntriesParams

type RequestEntriesParams struct {
	CacheID    CacheID `json:"cacheId"`              // ID of cache to get entries from.
	SkipCount  int64   `json:"skipCount,omitempty"`  // Number of records to skip.
	PageSize   int64   `json:"pageSize,omitempty"`   // Number of records to fetch.
	PathFilter string  `json:"pathFilter,omitempty"` // If present, only return the entries containing this substring in the path
}

RequestEntriesParams requests data from cache.

func RequestEntries

func RequestEntries(cacheID CacheID) *RequestEntriesParams

RequestEntries requests data from cache.

See: https://chromedevtools.github.io/devtools-protocol/tot/CacheStorage#method-requestEntries

parameters:

cacheID - ID of cache to get entries from.

func (*RequestEntriesParams) Do

func (p *RequestEntriesParams) Do(ctx context.Context) (cacheDataEntries []*DataEntry, returnCount float64, err error)

Do executes CacheStorage.requestEntries against the provided context.

returns:

cacheDataEntries - Array of object store data entries.
returnCount - Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.

func (RequestEntriesParams) MarshalEasyJSON

func (v RequestEntriesParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestEntriesParams) MarshalJSON

func (v RequestEntriesParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestEntriesParams) UnmarshalEasyJSON

func (v *RequestEntriesParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestEntriesParams) UnmarshalJSON

func (v *RequestEntriesParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (RequestEntriesParams) WithPageSize

func (p RequestEntriesParams) WithPageSize(pageSize int64) *RequestEntriesParams

WithPageSize number of records to fetch.

func (RequestEntriesParams) WithPathFilter

func (p RequestEntriesParams) WithPathFilter(pathFilter string) *RequestEntriesParams

WithPathFilter if present, only return the entries containing this substring in the path.

func (RequestEntriesParams) WithSkipCount

func (p RequestEntriesParams) WithSkipCount(skipCount int64) *RequestEntriesParams

WithSkipCount number of records to skip.

type RequestEntriesReturns

type RequestEntriesReturns struct {
	CacheDataEntries []*DataEntry `json:"cacheDataEntries,omitempty"` // Array of object store data entries.
	ReturnCount      float64      `json:"returnCount,omitempty"`      // Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.
}

RequestEntriesReturns return values.

func (RequestEntriesReturns) MarshalEasyJSON

func (v RequestEntriesReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RequestEntriesReturns) MarshalJSON

func (v RequestEntriesReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RequestEntriesReturns) UnmarshalEasyJSON

func (v *RequestEntriesReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RequestEntriesReturns) UnmarshalJSON

func (v *RequestEntriesReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

Jump to

Keyboard shortcuts

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