reader

Documentation

Index

• Constants
• Variables
• type Factory
  • func DetermineReader(filePath string) (Factory, error)
• type InputKind
• type InputValue
  • func ReadDir(dir string) (InputValue, error)
  • func ReadFile(filePath string) (InputValue, error)
  • func ReadGitHttps(gitPath string) (InputValue, error)
  • func ReadHttps(httpPath string) (InputValue, error)
  • func ReadSsh(sshPath string) (InputValue, error)

Constants

const (
	FilePrefix = "file"
	NoPrefix   = ""
)

const (
	HttpsPrefix = "https"
	HttpPrefix  = "http"
)

const (
	InputKindFile = "file"
	InputKindDir  = "dir"
)

const (
	SshPrefix      = "ssh"
	DefaultPort    = "22"
	DefaultPubFile = "id_ed25519"
)

const (
	GitHttpsPrefix = "git_https"
)

Variables

var InputSchemesMap = map[string]bool{

	FilePrefix:     true,
	HttpsPrefix:    true,
	HttpPrefix:     true,
	SshPrefix:      true,
	GitHttpsPrefix: true,
	NoPrefix:       true,
	// contains filtered or unexported fields
}

Types

type Factory

type Factory func(filePath string) (InputValue, error)

func DetermineReader

func DetermineReader(filePath string) (Factory, error)

type InputKind

type InputKind string

type InputValue

type InputValue struct {
	Kind  InputKind
	Value map[string][]byte
}

func ReadDir

func ReadDir(dir string) (InputValue, error)

ReadDir Reader protocol that reads content of provided directory.

func ReadFile

func ReadFile(filePath string) (InputValue, error)

ReadFile Reader protocol that reads content from a file no matter the extension.

func ReadGitHttps

func ReadGitHttps(gitPath string) (InputValue, error)

func ReadHttps

func ReadHttps(httpPath string) (InputValue, error)

ReadHttps Reader protocol that reads content of provided https url. It acts similarly to ReadFile since input is response body from url that is provided.

func ReadSsh

func ReadSsh(sshPath string) (InputValue, error)

ReadSsh Reader protocol that allows user to read content via ssh.