rewriter

Documentation

Overview

Copyright (C) 2023 by Posit Software, PBC

Index

• type RPackageRewriteError
  • func NewRPackageRewriteError(err error) RPackageRewriteError
  • func (r RPackageRewriteError) Error() string
  • func (r RPackageRewriteError) Is(err error) bool
• type RPackageRewriter
  • func NewRPackageRewriter(outputDir, readmeOutputDir, tempDir string, fpg fpg.FilePathGetter, ...) RPackageRewriter

Types

type RPackageRewriteError

type RPackageRewriteError struct {
	// contains filtered or unexported fields
}

RPackageRewriteError records an error during rewriting a package

func NewRPackageRewriteError

func NewRPackageRewriteError(err error) RPackageRewriteError

NewRPackageRewriteError creates a RPackageRewriteError

func (RPackageRewriteError) Error

func (r RPackageRewriteError) Error() string

func (RPackageRewriteError) Is

func (r RPackageRewriteError) Is(err error) bool

Is returns true if an error is a RPackageRewriteError

type RPackageRewriter

type RPackageRewriter interface {
	Rewrite(fullPath string) (*archive.RewriteResults, error)
	RewriteStream(r io.Reader, w io.Writer) (*archive.RewriteResults, error)
	RewriteBinary(r *os.File, w io.Writer, zip bool) (*archive.RewriteResults, error)
	GetReadme(stream io.Reader) (*archive.RewriteResults, error)
}

RPackageRewriter support rewriting source and binary packages

func NewRPackageRewriter

func NewRPackageRewriter(outputDir, readmeOutputDir, tempDir string, fpg fpg.FilePathGetter, bufferSize, gzipLevel int) RPackageRewriter

NewRPackageRewriter creates a new RPackageRewriter