bufprint

package

v0.0.0-...-26f4575 Latest Latest Go to latest Published: Mar 6, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/xiaoyawei/buf

Documentation ¶

Index ¶

Variables
func WithTabWriter(writer io.Writer, header []string, f func(TabWriter) error) (retErr error)
type CuratedPluginPrinter
- func NewCuratedPluginPrinter(writer io.Writer) CuratedPluginPrinter
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 RepositoryCommitPrinter
- func NewRepositoryCommitPrinter(writer io.Writer) RepositoryCommitPrinter
type RepositoryDraftPrinter
- func NewRepositoryDraftPrinter(writer io.Writer) RepositoryDraftPrinter
type RepositoryPrinter
- func NewRepositoryPrinter(clientConfig *connectclient.Config, address string, writer io.Writer) 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 CuratedPluginPrinter ¶

type CuratedPluginPrinter interface {
	PrintCuratedPlugin(ctx context.Context, format Format, plugin *registryv1alpha1.CuratedPlugin) error
	PrintCuratedPlugins(ctx context.Context, format Format, nextPageToken string, plugins ...*registryv1alpha1.CuratedPlugin) error
}

CuratedPluginPrinter is a printer for curated plugins.

func NewCuratedPluginPrinter ¶

func NewCuratedPluginPrinter(writer io.Writer) CuratedPluginPrinter

NewCuratedPluginPrinter returns a new CuratedPluginPrinter.

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 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 RepositoryDraftPrinter ¶

type RepositoryDraftPrinter interface {
	PrintRepositoryDraft(ctx context.Context, format Format, repositoryCommit *registryv1alpha1.RepositoryCommit) error
	PrintRepositoryDrafts(ctx context.Context, format Format, nextPageToken string, repositoryCommits ...*registryv1alpha1.RepositoryCommit) error
}

RepositoryDraftPrinter is a repository draft printer.

func NewRepositoryDraftPrinter ¶

func NewRepositoryDraftPrinter(writer io.Writer) RepositoryDraftPrinter

NewRepositoryDraftPrinter returns a new RepositoryDraftPrinter.

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(
	clientConfig *connectclient.Config,
	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