imagev1

Documentation

Index

• Variables
• type Image
  • func (*Image) Descriptor() ([]byte, []int)
  • func (x *Image) GetBufbuildImageExtension() *ImageExtension
  • func (x *Image) GetFile() []*descriptor.FileDescriptorProto
  • func (*Image) ProtoMessage()
  • func (x *Image) ProtoReflect() protoreflect.Message
  • func (x *Image) Reset()
  • func (x *Image) String() string
  • func (m *Image) Validate() error
• type ImageExtension
  • func (*ImageExtension) Descriptor() ([]byte, []int)
  • func (x *ImageExtension) GetImageImportRefs() []*ImageImportRef
  • func (*ImageExtension) ProtoMessage()
  • func (x *ImageExtension) ProtoReflect() protoreflect.Message
  • func (x *ImageExtension) Reset()
  • func (x *ImageExtension) String() string
  • func (m *ImageExtension) Validate() error
• type ImageExtensionValidationError
  • func (e ImageExtensionValidationError) Cause() error
  • func (e ImageExtensionValidationError) Error() string
  • func (e ImageExtensionValidationError) ErrorName() string
  • func (e ImageExtensionValidationError) Field() string
  • func (e ImageExtensionValidationError) Key() bool
  • func (e ImageExtensionValidationError) Reason() string
• type ImageImportRef
  • func (*ImageImportRef) Descriptor() ([]byte, []int)
  • func (x *ImageImportRef) GetFileIndex() uint32
  • func (*ImageImportRef) ProtoMessage()
  • func (x *ImageImportRef) ProtoReflect() protoreflect.Message
  • func (x *ImageImportRef) Reset()
  • func (x *ImageImportRef) String() string
  • func (m *ImageImportRef) Validate() error
• type ImageImportRefValidationError
  • func (e ImageImportRefValidationError) Cause() error
  • func (e ImageImportRefValidationError) Error() string
  • func (e ImageImportRefValidationError) ErrorName() string
  • func (e ImageImportRefValidationError) Field() string
  • func (e ImageImportRefValidationError) Key() bool
  • func (e ImageImportRefValidationError) Reason() string
• type ImageValidationError
  • func (e ImageValidationError) Cause() error
  • func (e ImageValidationError) Error() string
  • func (e ImageValidationError) ErrorName() string
  • func (e ImageValidationError) Field() string
  • func (e ImageValidationError) Key() bool
  • func (e ImageValidationError) Reason() string

Variables

var File_buf_image_v1_image_proto protoreflect.FileDescriptor

Types

type Image

type Image struct {

	// file matches the file field of a FileDescriptorSet.
	File []*descriptor.FileDescriptorProto `protobuf:"bytes,1,rep,name=file" json:"file,omitempty"`
	// bufbuild_image_extension is the ImageExtension for this image.
	//
	// The prefixed name and high tag value is used to all but guarantee there
	// will never be any conflict with Google's FileDescriptorSet definition.
	// The definition of a FileDescriptorSet has not changed in 11 years, so
	// we're not too worried about a conflict here.
	BufbuildImageExtension *ImageExtension `protobuf:"bytes,8042,opt,name=bufbuild_image_extension,json=bufbuildImageExtension" json:"bufbuild_image_extension,omitempty"`
	// contains filtered or unexported fields
}

Image is analogous to a FileDescriptorSet.

func (*Image) Descriptor

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

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetBufbuildImageExtension

func (x *Image) GetBufbuildImageExtension() *ImageExtension

func (*Image) GetFile

func (x *Image) GetFile() []*descriptor.FileDescriptorProto

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect

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

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

func (*Image) Validate

func (m *Image) Validate() error

Validate checks the field values on Image with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ImageExtension

type ImageExtension struct {

	// image_import_refs are the image import references for this specific Image.
	//
	// A given FileDescriptorProto may or may not be an import depending on
	// the image context, so this information is not stored on each FileDescriptorProto.
	ImageImportRefs []*ImageImportRef `protobuf:"bytes,1,rep,name=image_import_refs,json=imageImportRefs" json:"image_import_refs,omitempty"`
	// contains filtered or unexported fields
}

ImageExtension contains extensions to Images.

The fields are not included directly on the Image so that we can both detect if extensions exist, which signifies this was created by buf and not by protoc, and so that we can add fields in a freeform manner without worrying about conflicts with google.protobuf.FileDescriptorSet.

func (*ImageExtension) Descriptor

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

Deprecated: Use ImageExtension.ProtoReflect.Descriptor instead.

func (*ImageExtension) GetImageImportRefs

func (x *ImageExtension) GetImageImportRefs() []*ImageImportRef

func (*ImageExtension) ProtoMessage

func (*ImageExtension) ProtoMessage()

func (*ImageExtension) ProtoReflect

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

func (*ImageExtension) Reset

func (x *ImageExtension) Reset()

func (*ImageExtension) String

func (x *ImageExtension) String() string

func (*ImageExtension) Validate

func (m *ImageExtension) Validate() error

Validate checks the field values on ImageExtension with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ImageExtensionValidationError

type ImageExtensionValidationError struct {
	// contains filtered or unexported fields
}

ImageExtensionValidationError is the validation error returned by ImageExtension.Validate if the designated constraints aren't met.

func (ImageExtensionValidationError) Cause

func (e ImageExtensionValidationError) Cause() error

Cause function returns cause value.

func (ImageExtensionValidationError) Error

func (e ImageExtensionValidationError) Error() string

Error satisfies the builtin error interface

func (ImageExtensionValidationError) ErrorName

func (e ImageExtensionValidationError) ErrorName() string

ErrorName returns error name.

func (ImageExtensionValidationError) Field

func (e ImageExtensionValidationError) Field() string

Field function returns field value.

func (ImageExtensionValidationError) Key

func (e ImageExtensionValidationError) Key() bool

Key function returns key value.

func (ImageExtensionValidationError) Reason

func (e ImageExtensionValidationError) Reason() string

Reason function returns reason value.

type ImageImportRef

type ImageImportRef struct {

	// file_index is the index within the Image file array of the import.
	//
	// This signifies that file[file_index] is an import.
	// This field must be set.
	FileIndex *uint32 `protobuf:"varint,1,opt,name=file_index,json=fileIndex" json:"file_index,omitempty"`
	// contains filtered or unexported fields
}

ImageImportRef is a reference to an image import.

This is a message type instead of a scalar type so that we can add additional information about an import reference in the future, such as the external location of the import.

func (*ImageImportRef) Descriptor

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

Deprecated: Use ImageImportRef.ProtoReflect.Descriptor instead.

func (*ImageImportRef) GetFileIndex

func (x *ImageImportRef) GetFileIndex() uint32

func (*ImageImportRef) ProtoMessage

func (*ImageImportRef) ProtoMessage()

func (*ImageImportRef) ProtoReflect

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

func (*ImageImportRef) Reset

func (x *ImageImportRef) Reset()

func (*ImageImportRef) String

func (x *ImageImportRef) String() string

func (*ImageImportRef) Validate

func (m *ImageImportRef) Validate() error

Validate checks the field values on ImageImportRef with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ImageImportRefValidationError

type ImageImportRefValidationError struct {
	// contains filtered or unexported fields
}

ImageImportRefValidationError is the validation error returned by ImageImportRef.Validate if the designated constraints aren't met.

func (ImageImportRefValidationError) Cause

func (e ImageImportRefValidationError) Cause() error

Cause function returns cause value.

func (ImageImportRefValidationError) Error

func (e ImageImportRefValidationError) Error() string

Error satisfies the builtin error interface

func (ImageImportRefValidationError) ErrorName

func (e ImageImportRefValidationError) ErrorName() string

ErrorName returns error name.

func (ImageImportRefValidationError) Field

func (e ImageImportRefValidationError) Field() string

Field function returns field value.

func (ImageImportRefValidationError) Key

func (e ImageImportRefValidationError) Key() bool

Key function returns key value.

func (ImageImportRefValidationError) Reason

func (e ImageImportRefValidationError) Reason() string

Reason function returns reason value.

type ImageValidationError

type ImageValidationError struct {
	// contains filtered or unexported fields
}

ImageValidationError is the validation error returned by Image.Validate if the designated constraints aren't met.

func (ImageValidationError) Cause

func (e ImageValidationError) Cause() error

Cause function returns cause value.

func (ImageValidationError) Error

func (e ImageValidationError) Error() string

Error satisfies the builtin error interface

func (ImageValidationError) ErrorName

func (e ImageValidationError) ErrorName() string

ErrorName returns error name.

func (ImageValidationError) Field

func (e ImageValidationError) Field() string

Field function returns field value.

func (ImageValidationError) Key

func (e ImageValidationError) Key() bool

Key function returns key value.

func (ImageValidationError) Reason

func (e ImageValidationError) Reason() string

Reason function returns reason value.