package
1.50.0
Repository: https://github.com/bufbuild/buf.git
Documentation: pkg.go.dev

# Functions

BufLockFileWithDigestResolver returns a new BufLockFileOption that will resolve digests from commits.
BufYAMLFileWithIncludeDocsLink returns a new BufYAMLFileOption that specifies including a comment with a link to the public docs for the appropriate buf.yaml version at the top of the buf.yaml file.
GetBufGenYAMLFileForPrefix gets the buf.gen.yaml file at the given bucket prefix.
GetBufGenYAMLFileForPrefix gets the buf.gen.yaml file version at the given bucket prefix.
GetBufLockFileForPrefix gets the buf.lock file at the given bucket prefix.
GetBufLockFileVersionForPrefix gets the buf.lock file version at the given bucket prefix.
GetBufLockV1Beta1OrV1ObjectDataForPrefix is a helper function that gets the ObjectData for the buf.lock file at the given bucket prefix, if the buf.lock file was v1beta1 or v1.
GetBufWorkYAMLFileForPrefix gets the buf.work.yaml file at the given bucket prefix.
GetBufWorkYAMLFileForPrefix gets the buf.work.yaml file version at the given bucket prefix.
GetBufYAMLFileForOverride get the buf.yaml file for either the usually-flag-based override.
GetBufYAMLFileForPrefix gets the buf.yaml file at the given bucket prefix.
GetBufYAMLFileForOverride get the buf.yaml file for either the usually-flag-based override, or if the override is not set, falls back to the prefix.
GetBufYAMLFileForPrefix gets the buf.yaml file version at the given bucket prefix.
GetBufYAMLV1Beta1OrV1ObjectDataForPrefix is a helper function that gets the ObjectData for the buf.yaml file at the given bucket prefix, if the buf.yaml file was v1beta1 or v1.
NewBinaryImageInputConfig returns an input config for a binary image.
NewBreakingConfig returns a new BreakingConfig.
NewBufGenYAMLFile returns a new BufGenYAMLFile.
NewBufLockFile returns a new validated BufLockFile.
NewBufWorkYAMLFile returns a new validated BufWorkYAMLFile.
NewBufYAMLFile returns a new validated BufYAMLFile.
NewDirectoryInputConfig returns an input config for a directory.
NewEnabledCheckConfig returns a new enabled CheckConfig.
NewEnabledCheckConfig returns a new enabled CheckConfig for only the use IDs and categories.
NewGenerateConfig returns a validated GenerateConfig.
NewGenerateManagedConfig returns a new GenerateManagedConfig.
NewGeneratePluginConfigWithIncludeImportsAndWKT returns a GeneratePluginConfig the same as the input, with include imports and include wkt overridden.
NewGenerateTypeConfig returns a new GenerateTypeConfig.
NewGitRepoInputConfig returns an input config for a git repo.
NewJSONImageInputConfig returns an input config for a JSON image.
NewLintConfig returns a new LintConfig.
NewLocalGeneratePluginConfig returns a new GeneratePluginConfig for a local plugin.
NewLocalOrProtocBuiltinGeneratePluginConfig returns a new GeneratePluginConfig for a local or protoc builtin plugin.
NewLocalPluginConfig returns a new PluginConfig for a local plugin.
NewLocalWasmPluginConfig returns a new PluginConfig for a local Wasm plugin.
NewManagedDisableRule returns a new ManagedDisableRule.
NewManagedOverrideRuleForFieldOption returns a new ManagedOverrideRule for a field option.
NewFieldOptionOverrideRule returns a new ManagedOverrideRule for a file option.
NewModuleConfig returns a new ModuleConfig.
NewModuleInputConfig returns an input config for a module.
NewProtocBuiltinGeneratePluginConfig returns a new GeneratePluginConfig for a protoc builtin plugin.
NewProtoFileInputConfig returns an input config for a proto file.
NewRemoteGeneratePluginConfig returns a new GeneratePluginConfig for a remote plugin.
NewRemoteWasmPluginConfig returns a new PluginConfig for a remote Wasm plugin.
NewTarballInputConfig returns an input config for a tarball.
NewTextImageInputConfig returns an input config for a text image.
NewYAMLImageInputConfig returns an input config for a yaml image.
NewZipArchiveInputConfig returns an input config for a zip archive.
PutBufGenYAMLFileForPrefix puts the buf.gen.yaml file at the given bucket prefix.
PutBufLockFileForPrefix puts the buf.lock file at the given bucket prefix.
PutBufWorkYAMLFileForPrefix puts the buf.work.yaml file at the given bucket prefix.
PutBufYAMLFileForPrefix puts the buf.yaml file at the given bucket prefix.
ReadBufGenYAMLFile reads the BufGenYAMLFile from the io.Reader.
ReadBufLockFile reads the BufLockFile from the io.Reader.
ReadBufWorkYAMLFile reads the buf.work.yaml file from the io.Reader.
ReadBufYAMLFile reads the BufYAMLFile from the io.Reader.
WalkFileInfos walks all the FileInfos in the ReadBucket.
WriteBufGenYAMLFile writes the BufGenYAMLFile to the io.Writer.
WriteBufLockFile writes the BufLockFile to the io.Writer.
WriteBufWorkYAMLFile writes the buf.work.yaml to the io.Writer.
WriteBufYAMLFile writes the BufYAMLFile to the io.Writer.

# Constants

DefaultBufLockFileName is default buf.lock file name.
DefaultBufWorkYAMLFileName is the default buf.work.yaml file name.
DefaultBufYAMLFileName is the default buf.yaml file name.
FieldOptionJSType is the field option js_type.
FieldOptionUnspecified is an unspecified field option.
FileOptionCcEnableArenas is the file option cc_enable_arenas.
FileOptionCsharpNamespace is the file option csharp_namespace.
FileOptionCsharpNamespacePrefix is the file option csharp_namespace_prefix.
FileOptionGoPackage is the file option go_package.
FileOptionGoPackagePrefix is the file option go_package_prefix.
FileOptionJavaMultipleFiles is the file option java_multiple_files.
FileOptionJavaOuterClassname is the file option java_outer_classname.
FileOptionJavaPackage is the file option java_package.
FileOptionJavaPackagePrefix is the file option java_package_prefix.
FileOptionJavaPackageSuffix is the file option java_package_suffix.
FileOptionJavaStringCheckUtf8 is the file option java_string_check_utf8.
FileOptionObjcClassPrefix is the file option objc_class_prefix.
FileOptionOptimizeFor is the file option optimize_for.
FileOptionPhpMetadataNamespace is the file option php_metadata_namespace.
FileOptionPhpMetadataNamespaceSuffix is the file option php_metadata_namespace_suffix.
FileOptionPhpNamespace is the file option php_namespace.
FileOptionRubyPackage is the file option ruby_package.
FileOptionRubyPackageSuffix is the file option ruby_package_suffix.
FileOptionUnspecified is an unspecified file option.
FileTypeBufGenYAML represents buf.gen.yaml files.
FileTypeBufLock represents buf.lock files.
FileTypeBufWorkYAML represents buf.work.yaml files.
FileTypeBufYAML represents buf.yaml files.
FileVersionV1 represents v1 files.
FileVersionV1Beta represents v1beta1 files.
FileVersionV2 represents v2 files.
GeneratePluginConfigTypeLocal is the local plugin config type.
GeneratePluginConfigTypeLocalOrProtocBuiltin is a special plugin config type.
GeneratePluginConfigTypeProtocBuiltin is the protoc built-in plugin config type.
GeneratePluginConfigTypeRemote is the remote plugin config type.
GenerateStrategyAll is the strategy to generate with all files at once.
GenerateStrategyDirectory is the strategy to generate per directory.
InputConfigTypeBinaryImage is the binary image input type.
InputConfigTypeDirectory is the directory input type.
InputConfigTypeGitRepo is the git repository input type.
InputConfigTypeJSONImage is the JSON image input type.
InputConfigTypeModule is the module input type.
InputConfigTypeProtoFile is the proto file input type.
InputConfigTypeTarball is the tarball input type.
InputConfigTypeTextImage is the text image input type.
InputConfigTypeYAMLImage is the yaml image input type.
InputConfigTypeZipArchive is the zip archive input type.
PluginConfigTypeLocal is the local plugin config type.
PluginConfigTypeLocalWasm is the local Wasm plugin config type.
PluginConfigTypeRemoteWasm is the remote Wasm plugin config type.

# Variables

AllFileVersions are all FileVersions.
DefaultBreakingConfigV1 is the default breaking config for v1.
DefaultBreakingConfigV2 is the default breaking config for v1.
DefaultLintConfigV1 is the default lint config for v1.
DefaultLintConfigV2 is the default lint config for v2.
DefaultModuleConfigV1 is the default ModuleConfig for v1.
DefaultModuleConfigV2 is the default ModuleConfig for v1.
ProtocProxyPluginNames are the names of the plugins that should be proxied through protoc in the absence of a binary.

# Interfaces

BreakingConfig is breaking configuration for a specific Module.
BufGenYAMLFile represents a buf.gen.yaml file.
BufLockFile represents a buf.lock file.
BufWorkYAMLFile represents a buf.work.yaml file.
BufYAMLFile represents a buf.yaml file.
CheckConfig is the common interface for the configuration shared by LintConfig and BreakingConfig.
File is the common interface shared by all config files.
FileInfo contains information on a configuration file.
GenerateConfig is a generation configuration.
GenerateManagedConfig is a managed mode configuration.
GeneratePluginConfig is a configuration for a plugin.
GenerateTypeConfig is a type filter configuration.
InputConfig is an input configuration for code generation.
LintConfig is lint configuration for a specific Module.
ManagedDisableRule is a disable rule.
ManagedOverrideRule is an override rule.
ModuleConfig is configuration for a specific Module.
ObjectData is the data of the underlying storage.ReadObject that was used to create a Object.
PluginConfig is a configuration for a plugin.

# Type aliases

BufLockFileOption is an option for getting a new BufLockFile via Get or Read.
BufYAMLFileOption is an option for a new BufYAMLFile.
FieldOption is a field option.
FileOption is a file option.
FileType is the type of a file.
FileVersion is the version of a file.
GeneratePluginConfigType is a generate plugin configuration type.
GenerateStrategy is the generation strategy for a protoc plugin.
InputConfigType is an input config's type.
PluginConfigType is a generate plugin configuration type.