pkg

Documentation

Index

• Constants
• func DetectSize(targetURL, output string, showProgress bool) (total int64, rangeSupport bool, err error)
• func DownloadFileWithMultipleThread(targetURL, targetFilePath string, thread int, showProgress bool) (err error)
• func DownloadFileWithMultipleThreadKeepParts(targetURL, targetFilePath string, thread int, keepParts, showProgress bool) (err error)
• func DownloadWithContinue(targetURL, output string, index, continueAt, end int64, showProgress bool) (err error)
• func GetExternalIP() (string, error)
• func SetProxy(proxy, proxyAuth string, tr *http.Transport) (err error)
• type DownloadError
  • func (e *DownloadError) Error() string
• type HTTPDownloader
  • func (h *HTTPDownloader) DownloadFile() error
• type ProgressIndicator
  • func (i *ProgressIndicator) Init()
  • func (i *ProgressIndicator) Read(p []byte) (n int, err error)
  • func (i *ProgressIndicator) Write(p []byte) (n int, err error)
• type ReleaseAsset
• type ReleaseClient
  • func (g *ReleaseClient) GetJCLIAsset(tagName string) (*ReleaseAsset, error)
  • func (g *ReleaseClient) GetLatestAsset(acceptPreRelease bool) (*ReleaseAsset, error)
  • func (g *ReleaseClient) GetLatestJCLIAsset() (*ReleaseAsset, error)
  • func (g *ReleaseClient) GetLatestPreReleaseAsset(owner, repo string) (ra *ReleaseAsset, err error)
  • func (g *ReleaseClient) GetLatestReleaseAsset(owner, repo string) (ra *ReleaseAsset, err error)
  • func (g *ReleaseClient) GetReleaseAssetByTagName(owner, repo, tagName string) (ra *ReleaseAsset, err error)
  • func (g *ReleaseClient) Init()
• type RetryClient
  • func (c *RetryClient) Do(req *http.Request) (rsp *http.Response, err error)

Constants

const (
	// ContentType is for the http header of content type
	ContentType = "Content-Type"
	// ApplicationForm is for the form submit
	ApplicationForm = "application/x-www-form-urlencoded"
)

Functions

func DetectSize

func DetectSize(targetURL, output string, showProgress bool) (total int64, rangeSupport bool, err error)

DetectSize returns the size of target resource

func DownloadFileWithMultipleThread

func DownloadFileWithMultipleThread(targetURL, targetFilePath string, thread int, showProgress bool) (err error)

DownloadFileWithMultipleThread downloads the files with multiple threads

func DownloadFileWithMultipleThreadKeepParts

func DownloadFileWithMultipleThreadKeepParts(targetURL, targetFilePath string, thread int, keepParts, showProgress bool) (err error)

DownloadFileWithMultipleThreadKeepParts downloads the files with multiple threads

func DownloadWithContinue

func DownloadWithContinue(targetURL, output string, index, continueAt, end int64, showProgress bool) (err error)

DownloadWithContinue downloads the files continuously

func GetExternalIP

func GetExternalIP() (string, error)

GetExternalIP returns an external ip of current machine

func SetProxy

func SetProxy(proxy, proxyAuth string, tr *http.Transport) (err error)

SetProxy set the proxy for a http

Types

type DownloadError

type DownloadError struct {
	StatusCode int
	Message    string
}

DownloadError represents the error of HTTP download

func (*DownloadError) Error

func (e *DownloadError) Error() string

Error print the error message

type HTTPDownloader

type HTTPDownloader struct {
	TargetFilePath     string
	URL                string
	ShowProgress       bool
	InsecureSkipVerify bool

	UserName string
	Password string

	Proxy     string
	ProxyAuth string

	Header map[string]string

	// PreStart returns false will don't continue
	PreStart func(*http.Response) bool

	Thread      int
	Title       string
	Timeout     int
	MaxAttempts int

	Debug        bool
	RoundTripper http.RoundTripper
}

HTTPDownloader is the downloader for http request

func (*HTTPDownloader) DownloadFile

func (h *HTTPDownloader) DownloadFile() error

DownloadFile download a file with the progress

type ProgressIndicator

type ProgressIndicator struct {
	Writer io.Writer
	Reader io.Reader
	Title  string

	// bytes.Buffer
	Total float64
	// contains filtered or unexported fields
}

ProgressIndicator hold the progress of io operation

func (*ProgressIndicator) Init

func (i *ProgressIndicator) Init()

Init set the default value for progress indicator

func (*ProgressIndicator) Read

func (i *ProgressIndicator) Read(p []byte) (n int, err error)

Read reads the progress

func (*ProgressIndicator) Write

func (i *ProgressIndicator) Write(p []byte) (n int, err error)

Write writes the progress

type ReleaseAsset

type ReleaseAsset struct {
	TagName string
	Body    string
}

ReleaseAsset is the asset from GitHub release

type ReleaseClient

type ReleaseClient struct {
	Client *github.Client
	Org    string
	Repo   string
}

ReleaseClient is the client of jcli github

func (*ReleaseClient) GetJCLIAsset

func (g *ReleaseClient) GetJCLIAsset(tagName string) (*ReleaseAsset, error)

GetJCLIAsset returns the asset from a tag name

func (*ReleaseClient) GetLatestAsset

func (g *ReleaseClient) GetLatestAsset(acceptPreRelease bool) (*ReleaseAsset, error)

GetLatestAsset returns the latest release asset which can accept preRelease or not

func (*ReleaseClient) GetLatestJCLIAsset

func (g *ReleaseClient) GetLatestJCLIAsset() (*ReleaseAsset, error)

GetLatestJCLIAsset returns the latest jcli asset deprecated, please use GetLatestAsset instead

func (*ReleaseClient) GetLatestPreReleaseAsset

func (g *ReleaseClient) GetLatestPreReleaseAsset(owner, repo string) (ra *ReleaseAsset, err error)

GetLatestPreReleaseAsset returns the release asset that could be preRelease

func (*ReleaseClient) GetLatestReleaseAsset

func (g *ReleaseClient) GetLatestReleaseAsset(owner, repo string) (ra *ReleaseAsset, err error)

GetLatestReleaseAsset returns the latest release asset

func (*ReleaseClient) GetReleaseAssetByTagName

func (g *ReleaseClient) GetReleaseAssetByTagName(owner, repo, tagName string) (ra *ReleaseAsset, err error)

GetReleaseAssetByTagName returns the release asset by tag name

func (*ReleaseClient) Init

func (g *ReleaseClient) Init()

Init init the GitHub client

type RetryClient

type RetryClient struct {
	http.Client
	MaxAttempts int
	// contains filtered or unexported fields
}

RetryClient is the wrap of http.Client

func (*RetryClient) Do

func (c *RetryClient) Do(req *http.Request) (rsp *http.Response, err error)

Do is the wrap of http.Client.Do