stories

Documentation

Index

• type BuildCollectionOptions
• type BuildStorieOptions
  • func (bo BuildStorieOptions) Template(source fetcher.Result) (filetemplate.Template, error)
• type Collection
  • func BuildCollection(ctx context.Context, opt BuildCollectionOptions) (Collection, error)
  • func (c Collection) RemoveAll() error
• type Footer
• type Story
  • func BuildStory(ctx context.Context, opt BuildStorieOptions) (Story, error)
  • func (s Story) MoveVideo(target string) error
  • func (s Story) RemoveAll() error
  • func (s Story) RemoveStage() error

Types

type BuildCollectionOptions

type BuildCollectionOptions struct {
	Footer           Footer
	Sources          []string
	TemplateFilename string
	TargetDir        string
}

type BuildStorieOptions

type BuildStorieOptions struct {
	Footer           Footer
	TemplateFilename string
	SourceURL        string
	TargetDir        string
}

func (BuildStorieOptions) Template

func (bo BuildStorieOptions) Template(source fetcher.Result) (filetemplate.Template, error)

type Collection

type Collection []Story

func BuildCollection

func BuildCollection(ctx context.Context, opt BuildCollectionOptions) (Collection, error)

func (Collection) RemoveAll

func (c Collection) RemoveAll() error

type Footer

type Footer stages.Footer

type Story

type Story struct {
	Stage stages.Stage
	Video string
	Hash  string
}

func BuildStory

func BuildStory(ctx context.Context, opt BuildStorieOptions) (Story, error)

func (Story) MoveVideo

func (s Story) MoveVideo(target string) error

func (Story) RemoveAll

func (s Story) RemoveAll() error

func (Story) RemoveStage

func (s Story) RemoveStage() error