asset

Documentation

Index

• type Resource
  • func NewResource(pathToResource string, relTo *Resource) (*Resource, error)
  • func NewResourceFromStream(name string, source io.Reader) *Resource
  • func (r *Resource) IsRemote() bool
  • func (r *Resource) Path() string
  • func (r *Resource) RemotePath() string

Types

type Resource

type Resource struct {
	io.ReadCloser
	// contains filtered or unexported fields
}

The Resource class wraps a streamable file or remote Resource.

func NewResource

func NewResource(pathToResource string, relTo *Resource) (*Resource, error)

Create a new Resource data stream. If relTo is specified and pathToResource does not define a scheme, then the path to the new Resource will be generated by concatenating the base path of relTo and pathToResource.

This function can handle http/https URLs by delegating to the net/http package. The caller must make sure to close the returned io.ReadCloser to prevent mem leaks.

func NewResourceFromStream

func NewResourceFromStream(name string, source io.Reader) *Resource

Create a resource from a reader.

func (*Resource) IsRemote

func (r *Resource) IsRemote() bool

Returns true if the Resource is streamed over http/https.

func (*Resource) Path

func (r *Resource) Path() string

Returns the path to this resource.

func (*Resource) RemotePath

func (r *Resource) RemotePath() string

Return the remote path to this resource. If this is a remote resource then this method returns the base path (without leading /) of the remote URL. Otherwise, this method returns the same value as Path().