filesystem

Documentation

Overview

Package filesystem provides a filesystem Asset and Source implementation for d2loader

Index

• func OnAddSource(path string) (asset.Source, error)
• type Asset
  • func (fsa *Asset) Close() error
  • func (fsa *Asset) Data() ([]byte, error)
  • func (fsa *Asset) Path() string
  • func (fsa *Asset) Read(p []byte) (n int, err error)
  • func (fsa *Asset) Seek(offset int64, whence int) (int64, error)
  • func (fsa *Asset) Source() asset.Source
  • func (fsa *Asset) String() string
  • func (fsa *Asset) Type() types.AssetType
• type Source
  • func (s *Source) Exists(subPath string) bool
  • func (s *Source) Open(subPath string) (io.ReadSeeker, error)
  • func (s *Source) Path() string
  • func (s *Source) String() string
  • func (s *Source) Type() types.SourceType

Functions

func OnAddSource

func OnAddSource(path string) (asset.Source, error)

OnAddSource is a shim method to allow loading of filesystem sources

Types

type Asset

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

Asset represents an asset that is in the host filesystem

func (*Asset) Close

func (fsa *Asset) Close() error

Close closes the file

func (*Asset) Data

func (fsa *Asset) Data() ([]byte, error)

Data returns the raw file data as a slice of bytes

func (*Asset) Path

func (fsa *Asset) Path() string

Path returns the sub-path (within the asset source Root) for this asset

func (*Asset) Read

func (fsa *Asset) Read(p []byte) (n int, err error)

Read reads bytes into the given byte buffer

func (*Asset) Seek

func (fsa *Asset) Seek(offset int64, whence int) (int64, error)

Seek seeks within the file

func (*Asset) Source

func (fsa *Asset) Source() asset.Source

Source returns the asset source that this asset was loaded from

func (*Asset) String

func (fsa *Asset) String() string

String returns the path

func (*Asset) Type

func (fsa *Asset) Type() types.AssetType

Type returns the asset type

type Source

type Source struct {
	Root string
}

Source represents an asset source which is a normal directory on the host file system

func (*Source) Exists

func (s *Source) Exists(subPath string) bool

Exists returns true if the file exists

func (*Source) Open

func (s *Source) Open(subPath string) (io.ReadSeeker, error)

Open opens a file with the given sub-path within the Root dir of the file system source

func (*Source) Path

func (s *Source) Path() string

Path returns the Root dir of this file system source

func (*Source) String

func (s *Source) String() string

String returns the path

func (*Source) Type

func (s *Source) Type() types.SourceType

Type returns the type of this asset source