local

local

Internal package local provides local file-based catalog source implementation.

local

import "github.com/agentstation/starmap/internal/sources/local"

Index

• type Option
  • func WithCatalogPath(path string) Option
• type Source
  • func New(opts ...Option) *Source
  • func (s *Source) Catalog() catalogs.Catalog
  • func (s *Source) Cleanup() error
  • func (s *Source) Fetch(_ context.Context, _ ...sources.Option) error
  • func (s *Source) Setup(_ *catalogs.Providers) error
  • func (s *Source) Type() sources.Type

type Option

Option configures a local source.

type Option func(*Source)

func WithCatalogPath

func WithCatalogPath(path string) Option

WithCatalogPath sets the catalog path.

type Source

Source loads a catalog from either a file path or embedded catalog.

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

func New

func New(opts ...Option) *Source

New creates a new local source.

func (*Source) Catalog

func (s *Source) Catalog() catalogs.Catalog

Catalog returns the catalog of this source.

func (*Source) Cleanup

func (s *Source) Cleanup() error

Cleanup releases any resources.

func (*Source) Fetch

func (s *Source) Fetch(_ context.Context, _ ...sources.Option) error

Fetch returns catalog data from configured source.

func (*Source) Setup

func (s *Source) Setup(_ *catalogs.Providers) error

Setup initializes the source with dependencies.

func (*Source) Type

func (s *Source) Type() sources.Type

Type returns the type of this source.

Generated by gomarkdoc