util

Documentation

Index

• func GenerateTempPath() string
• func NewCustomSchemaManager(ctx SchemaContext) (*openbazaarSchemaManager, error)
• func NewSchemaManager() (*openbazaarSchemaManager, error)
• func OpenbazaarPathTransform(basePath string, testModeEnabled bool) (path string, err error)
• type SchemaContext

Functions

func GenerateTempPath

func GenerateTempPath() string

GenerateTempPath returns a string path representing the location where it is okay to store temporary data. No structure or created or deleted as part of this operation.

func NewCustomSchemaManager

func NewCustomSchemaManager(ctx SchemaContext) (*openbazaarSchemaManager, error)

NewCustomSchemaManger allows a custom SchemaContext to be provided to change

func NewSchemaManager

func NewSchemaManager() (*openbazaarSchemaManager, error)

NewSchemaManager returns a service that handles the data storage directory required during runtime. This service also ensures no errors can be produced at runtime after initial creation. An error may be produced if the SchemaManager is unable to verify the availability of the data storage directory.

func OpenbazaarPathTransform

func OpenbazaarPathTransform(basePath string, testModeEnabled bool) (path string, err error)

DefaultPathTransform accepts a string path representing the location where application data can be stored and returns a string representing the location where OpenBazaar prefers to store its schema on the filesystem relative to that path. If the path cannot be transformed, an error will be returned

Types

type SchemaContext

type SchemaContext struct {
	DataPath        string
	TestModeEnabled bool
	OS              string
}

SchemaContext are the parameters which the SchemaManager derive its source of truth. When their zero values are provided, a reasonable default will be assumed during runtime.