store

package

v0.0.0-...-d30cde0 Latest Latest Go to latest Published: Nov 23, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

FileStore manages the storage of scraped HTML documents, downloaded asset files, and parsed metadata in a designated directory.

func NewFileStore(rootDir, docName string) (*FileStore, error)

func (fs *FileStore) AssetFilePath(as *types.EmbeddedAsset) string

Absolute asset file path format: `${rootDir}/${docName}/${assetFilePath}/${assetFileName}`.

func (fs *FileStore) HtmlDocPath() string

Abosulte HTML document file format: `${rootDir}/${docName}.html`.

func (fs *FileStore) LoadMetadata() (*types.Metadata, error)

LoadMetadata loads metadata from json file.

func (fs *FileStore) MetadataFilePath() string

Metadata file path format: `${rootDir}/${docName}.json`

func (fs *FileStore) RelativeAssetFilePath(as *types.EmbeddedAsset) string

Relative asset file path format: `${docName}/${assetFilePath}/${assetFileName}`.

func (fs *FileStore) SaveAsset(as *types.EmbeddedAsset) error

SaveAsset saves embedded asset files.

func (fs *FileStore) SaveDoc(doc *goquery.Document) error

SaveDoc saves HTML document object.

func (fs *FileStore) SaveMetadata(metadata *types.Metadata) error

SaveMetadata saves the parsed metadata to `${rootDir}/${docName}.json`.