bufprint

package

v0.55.0 Latest Latest Go to latest Published: Sep 7, 2021 License: Apache-2.0 Imports: 15 Imported by: 32

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bufbuild/buf

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func WithTabWriter(writer io.Writer, header []string, f func(TabWriter) error) (retErr error)
type Format
- func ParseFormat(s string) (Format, error)
- func (f Format) String() string
type OrganizationPrinter
- func NewOrganizationPrinter(address string, writer io.Writer) OrganizationPrinter
type PluginPrinter
- func NewPluginPrinter(writer io.Writer) PluginPrinter
type PluginVersionPrinter
- func NewPluginVersionPrinter(writer io.Writer) PluginVersionPrinter
type RepositoryBranchPrinter
- func NewRepositoryBranchPrinter(writer io.Writer) RepositoryBranchPrinter
type RepositoryCommitPrinter
- func NewRepositoryCommitPrinter(writer io.Writer) RepositoryCommitPrinter
type RepositoryPrinter
- func NewRepositoryPrinter(apiProvider registryv1alpha1apiclient.Provider, address string, ...) RepositoryPrinter
type RepositoryTagPrinter
- func NewRepositoryTagPrinter(writer io.Writer) RepositoryTagPrinter
type TabWriter
type TemplatePrinter
- func NewTemplatePrinter(writer io.Writer) TemplatePrinter
type TemplateVersionPrinter
- func NewTemplateVersionPrinter(writer io.Writer) TemplateVersionPrinter
type TokenPrinter
- func NewTokenPrinter(writer io.Writer, format Format) (TokenPrinter, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// AllFormatsString is the string representation of all Formats.
	AllFormatsString = stringutil.SliceToString([]string{FormatText.String(), FormatJSON.String()})
)

Functions ¶

func WithTabWriter ¶

func WithTabWriter(
	writer io.Writer,
	header []string,
	f func(TabWriter) error,
) (retErr error)

WithTabWriter calls a function with a TabWriter.

Shared with internal packages.

Types ¶

type Format ¶

type Format int

Format is a format to print.

const (
	// FormatText is the text format.
	FormatText Format = 1
	// FormatJSON is the JSON format.
	FormatJSON Format = 2
)

func ParseFormat ¶

func ParseFormat(s string) (Format, error)

ParseFormat parses the format.

If the empty string is provided, this is interpeted as FormatText.

func (Format) String ¶

func (f Format) String() string

String implements fmt.Stringer.

type OrganizationPrinter ¶

type OrganizationPrinter interface {
	PrintOrganization(ctx context.Context, format Format, organization *registryv1alpha1.Organization) error
}

OrganizationPrinter is an organization printer.

func NewOrganizationPrinter ¶

func NewOrganizationPrinter(address string, writer io.Writer) OrganizationPrinter

NewOrganizationPrinter returns a new OrganizationPrinter.

type PluginPrinter ¶

type PluginPrinter interface {
	PrintPlugin(ctx context.Context, format Format, plugin *registryv1alpha1.Plugin) error
	PrintPlugins(ctx context.Context, format Format, nextPageToken string, plugins ...*registryv1alpha1.Plugin) error
}

PluginPrinter is a printer for plugins.

func NewPluginPrinter ¶

func NewPluginPrinter(writer io.Writer) PluginPrinter

NewPluginPrinter returns a new PluginPrinter.

type PluginVersionPrinter ¶

type PluginVersionPrinter interface {
	PrintPluginVersions(ctx context.Context, format Format, nextPageToken string, pluginVersions ...*registryv1alpha1.PluginVersion) error
}

PluginVersionPrinter is a printer for PluginVersions.

func NewPluginVersionPrinter ¶

func NewPluginVersionPrinter(writer io.Writer) PluginVersionPrinter

NewPluginVersionPrinter returns a new NewPluginVersionPrinter.

type RepositoryBranchPrinter ¶

type RepositoryBranchPrinter interface {
	PrintRepositoryBranch(ctx context.Context, format Format, repositoryBranch *registryv1alpha1.RepositoryBranch) error
	PrintRepositoryBranches(ctx context.Context, format Format, nextPageToken string, repositoryBranches ...*registryv1alpha1.RepositoryBranch) error
}

RepositoryBranchPrinter is a repository branch printer.

func NewRepositoryBranchPrinter ¶

func NewRepositoryBranchPrinter(writer io.Writer) RepositoryBranchPrinter

NewRepositoryBranchPrinter returns a new RepositoryBranchPrinter.

type RepositoryCommitPrinter ¶

type RepositoryCommitPrinter interface {
	PrintRepositoryCommit(ctx context.Context, format Format, repositoryCommit *registryv1alpha1.RepositoryCommit) error
	PrintRepositoryCommits(ctx context.Context, format Format, nextPageToken string, repositoryCommits ...*registryv1alpha1.RepositoryCommit) error
}

RepositoryCommitPrinter is a repository commit printer.

func NewRepositoryCommitPrinter ¶

func NewRepositoryCommitPrinter(writer io.Writer) RepositoryCommitPrinter

NewRepositoryCommitPrinter returns a new RepositoryCommitPrinter.

type RepositoryPrinter ¶

type RepositoryPrinter interface {
	PrintRepository(ctx context.Context, format Format, repository *registryv1alpha1.Repository) error
	PrintRepositories(ctx context.Context, format Format, nextPageToken string, repositories ...*registryv1alpha1.Repository) error
}

RepositoryPrinter is a repository printer.

func NewRepositoryPrinter ¶

func NewRepositoryPrinter(
	apiProvider registryv1alpha1apiclient.Provider,
	address string,
	writer io.Writer,
) RepositoryPrinter

NewRepositoryPrinter returns a new RepositoryPrinter.

type RepositoryTagPrinter ¶

type RepositoryTagPrinter interface {
	PrintRepositoryTag(ctx context.Context, format Format, repositoryTag *registryv1alpha1.RepositoryTag) error
	PrintRepositoryTags(ctx context.Context, format Format, nextPageToken string, repositoryTags ...*registryv1alpha1.RepositoryTag) error
}

RepositoryTagPrinter is a repository tag printer.

func NewRepositoryTagPrinter ¶

func NewRepositoryTagPrinter(writer io.Writer) RepositoryTagPrinter

NewRepositoryTagPrinter returns a new RepositoryTagPrinter.

type TabWriter ¶

type TabWriter interface {
	Write(values ...string) error
}

TabWriter is a tab writer.

type TemplatePrinter ¶

type TemplatePrinter interface {
	PrintTemplate(ctx context.Context, format Format, template *registryv1alpha1.Template) error
	PrintTemplates(ctx context.Context, format Format, nextPageToken string, templates ...*registryv1alpha1.Template) error
}

TemplatePrinter is a printer for Templates.

func NewTemplatePrinter ¶

func NewTemplatePrinter(writer io.Writer) TemplatePrinter

NewTemplatePrinter returns a new NewTemplatePrinter.

type TemplateVersionPrinter ¶

type TemplateVersionPrinter interface {
	PrintTemplateVersion(ctx context.Context, format Format, templateVersion *registryv1alpha1.TemplateVersion) error
	PrintTemplateVersions(ctx context.Context, format Format, nextPageToken string, templateVersions ...*registryv1alpha1.TemplateVersion) error
}

TemplateVersionPrinter is a printer for TemplateVersions.

func NewTemplateVersionPrinter ¶

func NewTemplateVersionPrinter(writer io.Writer) TemplateVersionPrinter

NewTemplateVersionPrinter returns a new NewTemplateVersionPrinter.

type TokenPrinter ¶

type TokenPrinter interface {
	PrintTokens(ctx context.Context, tokens ...*registryv1alpha1.Token) error
}

TokenPrinter is a printer Tokens.

TODO: update to same format as other printers.

func NewTokenPrinter ¶

func NewTokenPrinter(writer io.Writer, format Format) (TokenPrinter, error)

NewTokenPrinter returns a new TokenPrinter.

TODO: update to same format as other printers.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL