resource

Documentation

Index

• Constants
• type AfterScanner
• type BeforeScanner
• type Resource
  • func (o Resource) Notfound() bool
  • func (o Resource) Read() (data []byte, err error)
  • func (o Resource) ScanJson(v any) (err error)
  • func (o Resource) ScanYaml(v any) (err error)
  • func (o Resource) String() string

Constants

const NotfoundResource = Resource("")

Types

type AfterScanner

type AfterScanner interface {
	// AfterScan
	// called after resource scanned to any pointer struct.
	AfterScan() error
}

AfterScanner is an interface for resource scanner.

type BeforeScanner

type BeforeScanner interface {
	// BeforeScan
	// called before resource scanned to any pointer struct.
	BeforeScan() error
}

BeforeScanner is an interface for resource scanner.

type Resource

type Resource string

Resource is a type name for configuration file.

f := config.Resource("./config/app.yaml")
f := config.Resource("/data/sketch/config/app.yaml")

func (Resource) Notfound

func (o Resource) Notfound() bool

Notfound return true if resource is not found or name is empty string.

func (Resource) Read

func (o Resource) Read() (data []byte, err error)

Read reads resource content.

func (Resource) ScanJson

func (o Resource) ScanJson(v any) (err error)

ScanJson scans resource content of json to v.

func (Resource) ScanYaml

func (o Resource) ScanYaml(v any) (err error)

ScanYaml scans resource content of yaml to v.

func (Resource) String

func (o Resource) String() string

String return resource name.