options

Documentation

Index

• type AliasOptions
• type ExportOptions
• type FetchOptions
• type ImportOptions
• type Link
• type LinkOptions
• type LinkTarget
  • func (lt *LinkTarget) String() string
• type LinkTargetType
  • func (lt LinkTargetType) String() string
• type MergeOptions
• type Option
  • func WithCacheDir(dir string) Option
  • func WithConfigFile(file string) Option
  • func WithContext(ctx context.Context) Option
  • func WithLogger(l *log.Logger) Option
  • func WithVerbosity(level int) Option
• type Options
  • func New(opts ...Option) *Options
  • func (o *Options) Context() context.Context
  • func (o *Options) WithCacheDir(dir string) *Options
  • func (o *Options) WithConfigFile(file string) *Options
  • func (o *Options) WithContext(ctx context.Context) *Options
  • func (o *Options) WithLogger(l *log.Logger) *Options
  • func (o *Options) WithVerbosity(level int) *Options
• type PushOptions

Types

type AliasOptions

type AliasOptions struct {
	*Options
	Force bool
}

type ExportOptions

type ExportOptions struct {
	*Options
	OutputFile *os.File
	Format     formats.Format
}

type FetchOptions

type FetchOptions struct {
	*Options
	OutputFile *os.File
	Alias      string
	Tags       []string
	UseNetRC   bool
}

type ImportOptions

type ImportOptions struct {
	*Options
	InputFiles []*os.File
	Alias      []string
	Tags       []string
}

type Link

type Link struct {
	From LinkTarget
	To   []LinkTarget
}

type LinkOptions

type LinkOptions struct {
	*Options
	Links []Link
}

type LinkTarget

type LinkTarget struct {
	ID, Alias string
	Type      LinkTargetType
}

func (*LinkTarget) String

func (lt *LinkTarget) String() string

type LinkTargetType

type LinkTargetType uint8

const (
	LinkTargetTypeNode LinkTargetType = iota
	LinkTargetTypeDocument
)

func (LinkTargetType) String

func (lt LinkTargetType) String() string

type MergeOptions

type MergeOptions struct {
	*Options
	DocumentName string
	Alias        string
	Tags         []string
}

type Option

type Option func(*Options)

func WithCacheDir

func WithCacheDir(dir string) Option

func WithConfigFile

func WithConfigFile(file string) Option

func WithContext

func WithContext(ctx context.Context) Option

func WithLogger

func WithLogger(l *log.Logger) Option

func WithVerbosity

func WithVerbosity(level int) Option

type Options

type Options struct {
	Logger *log.Logger

	CacheDir   string
	ConfigFile string
	Verbosity  int
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Options

func (*Options) Context

func (o *Options) Context() context.Context

func (*Options) WithCacheDir

func (o *Options) WithCacheDir(dir string) *Options

func (*Options) WithConfigFile

func (o *Options) WithConfigFile(file string) *Options

func (*Options) WithContext

func (o *Options) WithContext(ctx context.Context) *Options

func (*Options) WithLogger

func (o *Options) WithLogger(l *log.Logger) *Options

func (*Options) WithVerbosity

func (o *Options) WithVerbosity(level int) *Options

type PushOptions

type PushOptions struct {
	*Options
	Format   formats.Format
	UseTree  bool
	UseNetRC bool
}