bufpolicy

Sep 16, 2025

Changes in this version

type BreakingConfig

+ DisableBuiltin func() bool

type LintConfig

+ DisableBuiltin func() bool

Jul 31, 2025

Changes in this version

+ func MarshalPolicyConfigAsJSON(policyConfig PolicyConfig) ([]byte, error)

+ type BreakingConfig interface

+ ExceptIDsAndCategories func() []string

+ IgnoreUnstablePackages func() bool

+ UseIDsAndCategories func() []string

+ func NewBreakingConfig(use []string, except []string, ignoreUnstablePackages bool) (BreakingConfig, error)

+ type LintConfig interface

+ EnumZeroValueSuffix func() string

+ ExceptIDsAndCategories func() []string

+ RPCAllowGoogleProtobufEmptyRequests func() bool

+ RPCAllowGoogleProtobufEmptyResponses func() bool

+ RPCAllowSameRequestResponse func() bool

+ ServiceSuffix func() string

+ UseIDsAndCategories func() []string

+ func NewLintConfig(use []string, except []string, enumZeroValueSuffix string, ...) (LintConfig, error)

+ type PluginConfig interface

+ Args func() []string

+ Name func() string

+ Options func() option.Options

+ Ref func() bufparse.Ref

+ func NewPluginConfig(name string, ref bufparse.Ref, options option.Options, args []string) (PluginConfig, error)

type Policy

+ Config func() (PolicyConfig, error)

+ type PolicyConfig interface

+ BreakingConfig func() BreakingConfig

+ LintConfig func() LintConfig

+ PluginConfigs func() []PluginConfig

+ func NewPolicyConfig(lintConfig LintConfig, breakingConfig BreakingConfig, ...) (PolicyConfig, error)

+ func UnmarshalJSONPolicyConfig(registry string, data []byte) (PolicyConfig, error)

type PolicyData

+ Config func() (PolicyConfig, error)

+ type PolicyPluginDataProvider interface

+ GetPluginDataProviderForPolicy func(policyName string) bufplugin.PluginDataProvider

+ var NopPolicyPluginDataProvider PolicyPluginDataProvider = nopPolicyPluginDataProvider{}

+ func NewStaticPolicyPluginDataProvider(policyNameToPluginDataProvider map[string]bufplugin.PluginDataProvider) (PolicyPluginDataProvider, error)

+ type PolicyPluginKeyProvider interface

+ GetPluginKeyProviderForPolicy func(policyName string) bufplugin.PluginKeyProvider

+ var NopPolicyPluginKeyProvider PolicyPluginKeyProvider = nopPolicyPluginKeyProvider{}

+ func NewStaticPolicyPluginKeyProvider(policyNameToPluginKeys map[string][]bufplugin.PluginKey) (PolicyPluginKeyProvider, error)

May 12, 2025

Changes in this version

type DigestType

+ const DigestTypeO1

Apr 21, 2025

Changes in this version

+ const PolicyVisibilityPrivate

+ const PolicyVisibilityPublic

+ var AllDigestTypes = []DigestType

+ func DigestEqual(a Digest, b Digest) bool

+ type Commit interface

+ CreateTime func() (time.Time, error)

+ PolicyKey func() PolicyKey

+ func NewCommit(policyKey PolicyKey, getCreateTime func() (time.Time, error)) Commit

+ type Digest interface

+ Type func() DigestType

+ Value func() []byte

+ func NewDigest(digestType DigestType, bufcasDigest bufcas.Digest) (Digest, error)

+ func ParseDigest(s string) (Digest, error)

+ type DigestMismatchError struct

+ ActualDigest Digest

+ CommitID uuid.UUID

+ ExpectedDigest Digest

+ FullName bufparse.FullName

+ func (m *DigestMismatchError) Error() string

+ type DigestType int

+ const DigestTypeP1

+ func ParseDigestType(s string) (DigestType, error)

+ func UniqueDigestTypeForPolicyKeys(policyKeys []PolicyKey) (DigestType, error)

+ func (d DigestType) String() string

+ type Policy interface

+ CommitID func() uuid.UUID

+ Data func() ([]byte, error)

+ Description func() string

+ Digest func(DigestType) (Digest, error)

+ FullName func() bufparse.FullName

+ IsLocal func() bool

+ Name func() string

+ OpaqueID func() string

+ func NewPolicy(description string, fullName bufparse.FullName, name string, ...) (Policy, error)

+ type PolicyData interface

+ Data func() ([]byte, error)

+ PolicyKey func() PolicyKey

+ func NewPolicyData(ctx context.Context, policyKey PolicyKey, getData func() ([]byte, error)) (PolicyData, error)

+ type PolicyDataProvider interface

+ GetPolicyDatasForPolicyKeys func(context.Context, []PolicyKey) ([]PolicyData, error)

+ var NopPolicyDataProvider PolicyDataProvider = nopPolicyDataProvider{}

+ type PolicyKey interface

+ CommitID func() uuid.UUID

+ Digest func() (Digest, error)

+ FullName func() bufparse.FullName

+ func NewPolicyKey(policyFullName bufparse.FullName, commitID uuid.UUID, ...) (PolicyKey, error)

+ type PolicyKeyProvider interface

+ GetPolicyKeysForPolicyRefs func(context.Context, []bufparse.Ref, DigestType) ([]PolicyKey, error)

+ var NopPolicyKeyProvider PolicyKeyProvider = nopPolicyKeyProvider{}

+ func NewStaticPolicyKeyProvider(policyKeys []PolicyKey) (PolicyKeyProvider, error)

+ type PolicyVisibility int

+ func ParsePolicyVisibility(s string) (PolicyVisibility, error)

+ type UploadOption func(*uploadOptions)

+ func UploadWithCreateIfNotExist(createPolicyVisibility PolicyVisibility) UploadOption

+ func UploadWithLabels(labels ...string) UploadOption

+ func UploadWithSourceControlURL(sourceControlURL string) UploadOption

+ type UploadOptions interface

+ CreateIfNotExist func() bool

+ CreatePolicyVisibility func() PolicyVisibility

+ Labels func() []string

+ SourceControlURL func() string

+ func NewUploadOptions(options []UploadOption) (UploadOptions, error)

+ type Uploader interface

+ Upload func(ctx context.Context, policies []Policy, options ...UploadOption) ([]Commit, error)

+ var NopUploader Uploader = nopUploader{}