model

Documentation

Index

• Variables
• type Episode
  • func (f Episode) Basename() string
  • func (f Episode) Extension() string
  • func (f Episode) FilePath() string
  • func (e *Episode) FullName() string
  • func (f Episode) ID() uuid.UUID
  • func (e *Episode) Index() int
  • func (e *Episode) Name() string
  • func (e *Episode) Season() *Season
  • func (f Episode) SetFilePath(path string)
  • func (f Episode) Subtitles(languages ...string) map[string]string
• type File
  • func Files(wd string, extensions []string, recursive bool) ([]*File, error)
  • func (f File) Basename() string
  • func (f File) Extension() string
  • func (f File) FilePath() string
  • func (f File) FullName() string
  • func (f File) ID() uuid.UUID
  • func (f File) Name() string
  • func (f File) SetFilePath(path string)
  • func (f File) Subtitles(languages ...string) map[string]string
• type Kind
  • func (k Kind) String() string
• type MediaFile
• type Movie
  • func Movies(wd string, extensions []string, recursive bool) ([]*Movie, error)
  • func (f Movie) Basename() string
  • func (f Movie) Extension() string
  • func (f Movie) FilePath() string
  • func (m *Movie) FullName() string
  • func (f Movie) ID() uuid.UUID
  • func (m *Movie) Name() string
  • func (f Movie) SetFilePath(path string)
  • func (m *Movie) SetName(name string)
  • func (m *Movie) SetYear(year int)
  • func (f Movie) Subtitles(languages ...string) map[string]string
  • func (m *Movie) Year() int
• type Season
  • func (s *Season) Episodes() []*Episode
  • func (s *Season) Index() int
  • func (s *Season) Name() string
  • func (s *Season) Show() *Show
• type Show
  • func Shows(wd string, extensions []string, recursive bool, subtitleExtension string, ...) ([]*Show, error)
  • func (s *Show) EpisodesCount() int
  • func (s *Show) Name() string
  • func (s *Show) Seasons() []*Season
  • func (s *Show) SeasonsCount() int
  • func (s *Show) SetName(name string)

Variables

var (
	ErrEmptyFilePath = errors.New("file path cannot be empty")
)

Types

type Episode

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

Holds information about an episode such as its index and subtitles.

func (Episode) Basename

func (f Episode) Basename() string

func (Episode) Extension

func (f Episode) Extension() string

func (Episode) FilePath

func (f Episode) FilePath() string

func (*Episode) FullName

func (e *Episode) FullName() string

func (Episode) ID

func (f Episode) ID() uuid.UUID

func (*Episode) Index

func (e *Episode) Index() int

func (*Episode) Name

func (e *Episode) Name() string

func (*Episode) Season

func (e *Episode) Season() *Season

func (Episode) SetFilePath

func (f Episode) SetFilePath(path string)

func (Episode) Subtitles

func (f Episode) Subtitles(languages ...string) map[string]string

type File

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

func Files

func Files(wd string, extensions []string, recursive bool) ([]*File, error)

Lists files in given folder.

Result can be filtered by extensions.

func (File) Basename

func (f File) Basename() string

func (File) Extension

func (f File) Extension() string

func (File) FilePath

func (f File) FilePath() string

func (File) FullName

func (f File) FullName() string

func (File) ID

func (f File) ID() uuid.UUID

func (File) Name

func (f File) Name() string

func (File) SetFilePath

func (f File) SetFilePath(path string)

func (File) Subtitles

func (f File) Subtitles(languages ...string) map[string]string

type Kind

type Kind string

const (
	KindAnime  Kind = "anime"
	KindMovie  Kind = "movie"
	KindTVShow Kind = "tvshow"
)

func (Kind) String

func (k Kind) String() string

type MediaFile

type MediaFile interface {
	Basename() string
	Extension() string
	FilePath() string
	FullName() string
	ID() uuid.UUID
	Name() string
	SetFilePath(path string)
	Subtitles(languages ...string) map[string]string
}

type Movie

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

Holds information about a file parsed as a movie such as its title and year.

func Movies

func Movies(wd string, extensions []string, recursive bool) ([]*Movie, error)

Lists movies in given folder.

Result can be filtered by extensions.

func (Movie) Basename

func (f Movie) Basename() string

func (Movie) Extension

func (f Movie) Extension() string

func (Movie) FilePath

func (f Movie) FilePath() string

func (*Movie) FullName

func (m *Movie) FullName() string

func (Movie) ID

func (f Movie) ID() uuid.UUID

func (*Movie) Name

func (m *Movie) Name() string

func (Movie) SetFilePath

func (f Movie) SetFilePath(path string)

func (*Movie) SetName

func (m *Movie) SetName(name string)

func (*Movie) SetYear

func (m *Movie) SetYear(year int)

func (Movie) Subtitles

func (f Movie) Subtitles(languages ...string) map[string]string

func (*Movie) Year

func (m *Movie) Year() int

type Season

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

Holds information about a season such as its index and episodes.

func (*Season) Episodes

func (s *Season) Episodes() []*Episode

func (*Season) Index

func (s *Season) Index() int

func (*Season) Name

func (s *Season) Name() string

func (*Season) Show

func (s *Season) Show() *Show

type Show

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

Holds information about a show such as its name and seasons.

func Shows

func Shows(wd string, extensions []string, recursive bool, subtitleExtension string, subtitleLangs []string, anyFiles bool) ([]*Show, error)

func (*Show) EpisodesCount

func (s *Show) EpisodesCount() int

func (*Show) Name

func (s *Show) Name() string

func (*Show) Seasons

func (s *Show) Seasons() []*Season

func (*Show) SeasonsCount

func (s *Show) SeasonsCount() int

func (*Show) SetName

func (s *Show) SetName(name string)