internal

type ArchiveFormatOption func(*archiveFormatInfo)

type ArchiveRef interface {
	FileRef
	BucketRef
	ArchiveType() ArchiveType
	// Applied before subdir
	StripComponents() uint32
	// Will be empty instead of "." for root directory
	SubDirPath() string
	// contains filtered or unexported methods
}

type ArchiveType int

type BucketRef interface {
	Ref
	// contains filtered or unexported methods
}

type CompressionType int

type DirFormatOption func(*dirFormatInfo)

type DirRef interface {
	// Path is the path to the reference.
	//
	// This will be the non-empty normalized directory path for directories.
	Path() string
	BucketRef
	// contains filtered or unexported methods
}

type FileRef interface {
	Ref
	// Path is the path to the reference.
	//
	// This will be the non-empty path minus the scheme for http and https files.
	// This will be the non-empty normalized file path for local files.
	// This will be empty for stdio and null files.
	Path() string
	FileScheme() FileScheme
	CompressionType() CompressionType
	// contains filtered or unexported methods
}

type FileScheme int

type GetBucketOption func(*getBucketOptions)

type GetFileOption func(*getFileOptions)

type GetModuleOption func(*getModuleOptions)

type GetParsedRefOption func(*getParsedRefOptions)

type GitFormatOption func(*gitFormatInfo)

type GitRef interface {
	// Path is the path to the reference.
	//
	// This will be the non-empty path minus the scheme for http, https, ssh, and git repositories.
	// This will be the non-empty normalized directory path for local git repositories.
	Path() string
	BucketRef
	GitScheme() GitScheme
	// Optional. May be nil, in which case clone the default branch.
	GitName() git.Name
	// Will always be >= 1
	Depth() uint32
	RecurseSubmodules() bool
	// Will be empty instead of "." for root directory
	SubDirPath() string
	// contains filtered or unexported methods
}

type GitScheme int

type HasFormat interface {
	Format() string
}

type ModuleFormatOption func(*moduleFormatInfo)

type ModuleRef interface {
	Ref
	ModuleReference() bufmodule.ModuleReference
	// contains filtered or unexported methods
}

type ParsedArchiveRef interface {
	ArchiveRef
	HasFormat
}

type ParsedBucketRef interface {
	BucketRef
	HasFormat
}

type ParsedDirRef interface {
	DirRef
	HasFormat
}

type ParsedFileRef interface {
	FileRef
	HasFormat
}

type ParsedGitRef interface {
	GitRef
	HasFormat
}

type ParsedModuleRef interface {
	ModuleRef
	HasFormat
}

type ParsedRef interface {
	Ref
	HasFormat
}

type ParsedSingleRef interface {
	SingleRef
	HasFormat
}

type PutFileOption func(*putFileOptions)

type RawRef struct {
	// Will always be set
	// Not normalized yet
	Path string
	// Will always be set
	// Set via RawRefProcessor if not explicitly set
	Format string
	// Only set for single, archive formats
	// Cannot be set for zip archives
	CompressionType CompressionType
	// Only set for archive, git formats
	SubDirPath string
	// Only set for git formats
	// Only one of GitBranch and GitTag will be set
	GitBranch string
	// Only set for git formats
	// Only one of GitBranch and GitTag will be set
	GitTag string
	// Only set for git formats
	// Specifies an exact git reference to use with git checkout.
	// Can be used on its own or with GitBranch. Not allowed with GitTag.
	// This is defined as anything that can be given to git checkout.
	GitRef string
	// Only set for git formats
	GitRecurseSubmodules bool
	// Only set for git formats.
	// The depth to use when cloning a repository. Only allowed when GitRef
	// is set. Defaults to 50 if unset.
	GitDepth uint32
	// Only set for archive formats
	ArchiveStripComponents uint32
}

type ReadBucketCloser interface {
	storage.ReadBucketCloser

	// RelativeRootPath is the relative path to the root of the bucket
	// based on the current working directory.
	//
	// This will be set if a terminate filename was specified and found.
	RelativeRootPath() string
	// SubDirPath is the subdir within the Bucket of the actual asset.
	//
	// This will be set if a terminate filename was specified and found.
	// If so, the actual Bucket will be the directory that contained
	// this terminate file, and the subdir will be the subdir of
	// the actual asset relative to the terminate file.
	SubDirPath() string
}

type ReadWriteBucketCloser interface {
	ReadBucketCloser
	storage.WriteBucket
}

type Reader interface {
	// GetFile gets the file.
	// SingleRefs and ArchiveRefs will result in decompressed files unless KeepFileCompression is set.
	GetFile(
		ctx context.Context,
		container app.EnvStdinContainer,
		fileRef FileRef,
		options ...GetFileOption,
	) (io.ReadCloser, error)
	// GetBucket gets the bucket.
	//
	// The returned ReadBucketCloser may actually be upgradeable to a ReadWriteBucketCloser.
	GetBucket(
		ctx context.Context,
		container app.EnvStdinContainer,
		bucketRef BucketRef,
		options ...GetBucketOption,
	) (ReadBucketCloser, error)
	// GetModule gets the module.
	GetModule(
		ctx context.Context,
		container app.EnvStdinContainer,
		moduleRef ModuleRef,
		options ...GetModuleOption,
	) (bufmodule.Module, error)
}

type ReaderOption func(*reader)

type Ref interface {
	// contains filtered or unexported methods
}

type RefParser interface {
	// GetParsedRef gets the ParsedRef for the value.
	//
	// The returned ParsedRef will be either a ParsedSingleRef, ParsedArchiveRef, ParsedDirRef, ParsedGitRef, or ParsedModuleRef.
	//
	// The options should be used to validate that you are getting one of the correct formats.
	GetParsedRef(ctx context.Context, value string, options ...GetParsedRefOption) (ParsedRef, error)
}

type RefParserOption func(*refParser)

type SingleFormatOption func(*singleFormatInfo)

type SingleRef interface {
	FileRef
	// contains filtered or unexported methods
}

type Writer interface {
	// PutFile puts the file.
	PutFile(
		ctx context.Context,
		container app.EnvStdoutContainer,
		fileRef FileRef,
		options ...PutFileOption,
	) (io.WriteCloser, error)
}

type WriterOption func(*writer)