modulev1alpha1

package
v1.47.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2024 License: Apache-2.0 Imports: 7 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	DigestType_name = map[int32]string{
		0: "DIGEST_TYPE_UNSPECIFIED",
		1: "DIGEST_TYPE_SHAKE256",
	}
	DigestType_value = map[string]int32{
		"DIGEST_TYPE_UNSPECIFIED": 0,
		"DIGEST_TYPE_SHAKE256":    1,
	}
)

Enum value maps for DigestType.

View Source 
var File_buf_alpha_module_v1alpha1_module_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Blob added in v1.13.0 

type Blob struct {

	// Digest of the content.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest,proto3" json:"digest,omitempty"`
	// Content of the blob.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Blob represents some module content with an associated digest.

func (*Blob) Descriptor deprecated added in v1.13.0 

func (*Blob) Descriptor() ([]byte, []int)

Deprecated: Use Blob.ProtoReflect.Descriptor instead.

func (*Blob) GetContent added in v1.13.0 

func (x *Blob) GetContent() []byte

func (*Blob) GetDigest added in v1.13.0 

func (x *Blob) GetDigest() *Digest

func (*Blob) ProtoMessage added in v1.13.0 

func (*Blob) ProtoMessage()

func (*Blob) ProtoReflect added in v1.13.0 

func (x *Blob) ProtoReflect() protoreflect.Message

func (*Blob) Reset added in v1.13.0 

func (x *Blob) Reset()

func (*Blob) String added in v1.13.0 

func (x *Blob) String() string

type Digest added in v1.13.0 

type Digest struct {

	// digest_type describes the hash algorithm. e.g. "SHAKE256"
	DigestType DigestType `` /* 134-byte string literal not displayed */
	// digest is the hash's output without encoding.
	Digest []byte `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"`
	// contains filtered or unexported fields
}

Digest represents a hash function's value.

func (*Digest) Descriptor deprecated added in v1.13.0 

func (*Digest) Descriptor() ([]byte, []int)

Deprecated: Use Digest.ProtoReflect.Descriptor instead.

func (*Digest) GetDigest added in v1.13.0 

func (x *Digest) GetDigest() []byte

func (*Digest) GetDigestType added in v1.13.0 

func (x *Digest) GetDigestType() DigestType

func (*Digest) ProtoMessage added in v1.13.0 

func (*Digest) ProtoMessage()

func (*Digest) ProtoReflect added in v1.13.0 

func (x *Digest) ProtoReflect() protoreflect.Message

func (*Digest) Reset added in v1.13.0 

func (x *Digest) Reset()

func (*Digest) String added in v1.13.0 

func (x *Digest) String() string

type DigestType added in v1.13.0 

type DigestType int32
const (
	DigestType_DIGEST_TYPE_UNSPECIFIED DigestType = 0
	DigestType_DIGEST_TYPE_SHAKE256    DigestType = 1
)

func (DigestType) Descriptor added in v1.13.0 

func (DigestType) Descriptor() protoreflect.EnumDescriptor

func (DigestType) Enum added in v1.13.0 

func (x DigestType) Enum() *DigestType

func (DigestType) EnumDescriptor deprecated added in v1.13.0 

func (DigestType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DigestType.Descriptor instead.

func (DigestType) Number added in v1.13.0 

func (x DigestType) Number() protoreflect.EnumNumber

func (DigestType) String added in v1.13.0 

func (x DigestType) String() string

func (DigestType) Type added in v1.13.0 

func (DigestType) Type() protoreflect.EnumType

type Module 

type Module struct {

	// files are the files that make up the set.
	//
	// Sorted by path.
	// Path must be unique.
	// Only the target files. No imports.
	//
	// Maximum total size of all content: 32MB.
	Files []*ModuleFile `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// dependencies are the dependencies.
	Dependencies []*ModulePin `protobuf:"bytes,2,rep,name=dependencies,proto3" json:"dependencies,omitempty"`
	// documentation is the string representation of the contents of the file at documentation_path.
	//
	// string is used to enforce UTF-8 encoding or 7-bit ASCII text.
	Documentation string `protobuf:"bytes,3,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// breaking_config is the breaking change detection configuration set for the module.
	BreakingConfig *v1.Config `protobuf:"bytes,4,opt,name=breaking_config,json=breakingConfig,proto3" json:"breaking_config,omitempty"`
	// lint_config is the lint configuration set for the module.
	LintConfig *v11.Config `protobuf:"bytes,5,opt,name=lint_config,json=lintConfig,proto3" json:"lint_config,omitempty"`
	// license is the string representation of the contents of the `LICENSE` file.
	//
	// string is used to enforce UTF-8 encoding or 7-bit ASCII text.
	License string `protobuf:"bytes,6,opt,name=license,proto3" json:"license,omitempty"`
	// documentation_path is the path of the file which contains the module documentation.
	//
	// either `buf.md`, `README.md` or `README.markdown`.
	// if empty, assumes buf.md.
	DocumentationPath string `protobuf:"bytes,7,opt,name=documentation_path,json=documentationPath,proto3" json:"documentation_path,omitempty"`
	// contains filtered or unexported fields
}

Module is a module.

func (*Module) Descriptor deprecated 

func (*Module) Descriptor() ([]byte, []int)

Deprecated: Use Module.ProtoReflect.Descriptor instead.

func (*Module) GetBreakingConfig added in v1.0.0 

func (x *Module) GetBreakingConfig() *v1.Config

func (*Module) GetDependencies 

func (x *Module) GetDependencies() []*ModulePin

func (*Module) GetDocumentation 

func (x *Module) GetDocumentation() string

func (*Module) GetDocumentationPath added in v1.18.0 

func (x *Module) GetDocumentationPath() string

func (*Module) GetFiles 

func (x *Module) GetFiles() []*ModuleFile

func (*Module) GetLicense added in v1.9.0 

func (x *Module) GetLicense() string

func (*Module) GetLintConfig added in v1.0.0 

func (x *Module) GetLintConfig() *v11.Config

func (*Module) ProtoMessage 

func (*Module) ProtoMessage()

func (*Module) ProtoReflect 

func (x *Module) ProtoReflect() protoreflect.Message

func (*Module) Reset 

func (x *Module) Reset()

func (*Module) String 

func (x *Module) String() string

type ModuleFile 

type ModuleFile struct {

	// path is the relative path of the file.
	// Path can only use '/' as the separator character, and includes no ".." components.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// content is the content of the file.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

ModuleFile is a file within a FileSet.

func (*ModuleFile) Descriptor deprecated 

func (*ModuleFile) Descriptor() ([]byte, []int)

Deprecated: Use ModuleFile.ProtoReflect.Descriptor instead.

func (*ModuleFile) GetContent 

func (x *ModuleFile) GetContent() []byte

func (*ModuleFile) GetPath 

func (x *ModuleFile) GetPath() string

func (*ModuleFile) ProtoMessage 

func (*ModuleFile) ProtoMessage()

func (*ModuleFile) ProtoReflect 

func (x *ModuleFile) ProtoReflect() protoreflect.Message

func (*ModuleFile) Reset 

func (x *ModuleFile) Reset()

func (*ModuleFile) String 

func (x *ModuleFile) String() string

type ModulePin 

type ModulePin struct {
	Remote     string `protobuf:"bytes,1,opt,name=remote,proto3" json:"remote,omitempty"`
	Owner      string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"`
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"`
	Commit     string `protobuf:"bytes,5,opt,name=commit,proto3" json:"commit,omitempty"`
	// Module's manifest digest. Replacement for previous b1/b3 digests.
	// This is in the format '<digest_type>:<digest>`, where '<digest_type>' is the lowercase digest name ('shake256'),
	// and '<digest>' is the lowercase hex-encoded digest.
	// This value is persisted directly to the buf.lock file (https://buf.build/docs/configuration/v1/buf-lock) as the 'digest' key.
	ManifestDigest string `protobuf:"bytes,8,opt,name=manifest_digest,json=manifestDigest,proto3" json:"manifest_digest,omitempty"`
	// contains filtered or unexported fields
}

ModulePin is a module pin.

func (*ModulePin) Descriptor deprecated 

func (*ModulePin) Descriptor() ([]byte, []int)

Deprecated: Use ModulePin.ProtoReflect.Descriptor instead.

func (*ModulePin) GetCommit 

func (x *ModulePin) GetCommit() string

func (*ModulePin) GetManifestDigest added in v1.13.0 

func (x *ModulePin) GetManifestDigest() string

func (*ModulePin) GetOwner 

func (x *ModulePin) GetOwner() string

func (*ModulePin) GetRemote 

func (x *ModulePin) GetRemote() string

func (*ModulePin) GetRepository 

func (x *ModulePin) GetRepository() string

func (*ModulePin) ProtoMessage 

func (*ModulePin) ProtoMessage()

func (*ModulePin) ProtoReflect 

func (x *ModulePin) ProtoReflect() protoreflect.Message

func (*ModulePin) Reset 

func (x *ModulePin) Reset()

func (*ModulePin) String 

func (x *ModulePin) String() string

type ModuleReference 

type ModuleReference struct {
	Remote     string `protobuf:"bytes,1,opt,name=remote,proto3" json:"remote,omitempty"`
	Owner      string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"`
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"`
	// either tag, or commit
	Reference string `protobuf:"bytes,4,opt,name=reference,proto3" json:"reference,omitempty"`
	// contains filtered or unexported fields
}

ModuleReference is a module reference.

func (*ModuleReference) Descriptor deprecated 

func (*ModuleReference) Descriptor() ([]byte, []int)

Deprecated: Use ModuleReference.ProtoReflect.Descriptor instead.

func (*ModuleReference) GetOwner 

func (x *ModuleReference) GetOwner() string

func (*ModuleReference) GetReference 

func (x *ModuleReference) GetReference() string

func (*ModuleReference) GetRemote 

func (x *ModuleReference) GetRemote() string

func (*ModuleReference) GetRepository 

func (x *ModuleReference) GetRepository() string

func (*ModuleReference) ProtoMessage 

func (*ModuleReference) ProtoMessage()

func (*ModuleReference) ProtoReflect 

func (x *ModuleReference) ProtoReflect() protoreflect.Message

func (*ModuleReference) Reset 

func (x *ModuleReference) Reset()

func (*ModuleReference) String 

func (x *ModuleReference) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.