fs

Documentation

Overview

Package fs provides a read-only template store backed by an fs.FS, suitable for use with embed.FS or any other fs.FS implementation. For mutable storage, wrap this in a composite.Store with a writable provider such as memory.Store.

Index

• func NewStore(fsys fs.FS) func() *Store
• type Store
  • func (s *Store) Get(_ context.Context, name string) ([]byte, error)
  • func (s *Store) List(_ context.Context) ([]string, error)
  • func (s *Store) Register(_ context.Context, _ string, _ []byte) error
  • func (s *Store) RegisterFS(_ context.Context, _ fs.FS) error

Functions

func NewStore

func NewStore(fsys fs.FS) func() *Store

NewStore returns a DI-injectable constructor for a read-only template store backed by fsys. Only files with the ".html" extension are recognized.

Types

type Store

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

Store reads templates from an fs.FS. Register and RegisterFS return template.ErrReadOnly — use composite.Store for mutability.

func (*Store) Get

func (s *Store) Get(_ context.Context, name string) ([]byte, error)

Get returns the raw template content by name. Returns template.ErrTemplateNotFound if the file is not present.

func (*Store) List

func (s *Store) List(_ context.Context) ([]string, error)

List returns all template names from the fs.FS in sorted order.

func (*Store) Register

func (s *Store) Register(_ context.Context, _ string, _ []byte) error

Register always returns template.ErrReadOnly.

func (*Store) RegisterFS

func (s *Store) RegisterFS(_ context.Context, _ fs.FS) error

RegisterFS always returns template.ErrReadOnly.