source

Documentation

Overview

Package source is the interface for filesystems.

Index

• Variables
• func NewGitHubFs(repoOwner, repoName string, token *string, options ...GitHubFsOption) (afero.Fs, error)
• func NewS3Fs(s3Url string, sessCfg *aws.Config) afero.Fs
• func ReadLimited(r io.Reader, limit int) (content []byte, n int64, err error)
• type GitHubFsOption
  • func GitHubRef(ref string) GitHubFsOption

Variables

var (
	// ErrUnimplemented is returned when a method is not implemented.
	ErrUnimplemented = errors.New("unimplemented")
	// ErrReadonly is returned when this filesystem is readonly.
	ErrReadonly = errors.New("readonly")
	// ErrNotDir is returned when something is not a directory.
	ErrNotDir = errors.New("not a directory")
)

var ErrOverSized = errors.New("oversized reader")

ErrOverSized is the error when the reader exceeds the limit.

Functions

func NewGitHubFs

func NewGitHubFs(repoOwner, repoName string, token *string, options ...GitHubFsOption) (afero.Fs, error)

NewGitHubFs creates a new github filesystem.

func NewS3Fs

func NewS3Fs(s3Url string, sessCfg *aws.Config) afero.Fs

NewS3Fs creates a new S3 filesystem with the given bucket name.

func ReadLimited

func ReadLimited(r io.Reader, limit int) (content []byte, n int64, err error)

ReadLimited reads from r until limit bytes or EOF, whichever comes first. If the limit is exceeded, it returns an error.

It returns the content read, the number of bytes read, and any error occurred.

Types

type GitHubFsOption

type GitHubFsOption func(*githubFsOptions)

GitHubFsOption is the option for NewGitHubFs.

func GitHubRef

func GitHubRef(ref string) GitHubFsOption

GitHubRef sets the ref of the GitHub repository.