Documentation
¶
Overview ¶
These commands work around namespace conflicts that occur when multiple repositories depend on .proto files with generic filenames. Due to the way protobuf registers files (e.g., foo.proto or pb/foo.proto), naming collisions can occur when the same filename is used across different packages.
The only way to generate a *.pb.go file that includes the full package path (e.g., github.com/org/repo/pb/foo.proto) is to place the .proto file in a directory structure that mirrors its package path.
References:
Index ¶
- Variables
- type IpnsRecord
- func (*IpnsRecord) Descriptor() ([]byte, []int)deprecated
- func (x *IpnsRecord) GetData() []byte
- func (x *IpnsRecord) GetPubKey() []byte
- func (x *IpnsRecord) GetSequence() uint64
- func (x *IpnsRecord) GetSignatureV1() []byte
- func (x *IpnsRecord) GetSignatureV2() []byte
- func (x *IpnsRecord) GetTtl() uint64
- func (x *IpnsRecord) GetValidity() []byte
- func (x *IpnsRecord) GetValidityType() IpnsRecord_ValidityType
- func (x *IpnsRecord) GetValue() []byte
- func (*IpnsRecord) ProtoMessage()
- func (x *IpnsRecord) ProtoReflect() protoreflect.Message
- func (x *IpnsRecord) Reset()
- func (x *IpnsRecord) String() string
- type IpnsRecord_ValidityType
- func (IpnsRecord_ValidityType) Descriptor() protoreflect.EnumDescriptor
- func (x IpnsRecord_ValidityType) Enum() *IpnsRecord_ValidityType
- func (IpnsRecord_ValidityType) EnumDescriptor() ([]byte, []int)deprecated
- func (x IpnsRecord_ValidityType) Number() protoreflect.EnumNumber
- func (x IpnsRecord_ValidityType) String() string
- func (IpnsRecord_ValidityType) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
View Source
var ( IpnsRecord_ValidityType_name = map[int32]string{ 0: "EOL", } IpnsRecord_ValidityType_value = map[string]int32{ "EOL": 0, } )
Enum value maps for IpnsRecord_ValidityType.
View Source
var File_github_com_ipfs_boxo_ipns_pb_record_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type IpnsRecord ¶ added in v0.11.0
type IpnsRecord struct {
// 1-6 are legacy fields used only in V1+V2 records
Value []byte `protobuf:"bytes,1,opt,name=value,proto3,oneof" json:"value,omitempty"`
SignatureV1 []byte `protobuf:"bytes,2,opt,name=signatureV1,proto3,oneof" json:"signatureV1,omitempty"`
ValidityType *IpnsRecord_ValidityType `` /* 131-byte string literal not displayed */
Validity []byte `protobuf:"bytes,4,opt,name=validity,proto3,oneof" json:"validity,omitempty"`
Sequence *uint64 `protobuf:"varint,5,opt,name=sequence,proto3,oneof" json:"sequence,omitempty"`
Ttl *uint64 `protobuf:"varint,6,opt,name=ttl,proto3,oneof" json:"ttl,omitempty"`
// 7-9 are V2 records
PubKey []byte `protobuf:"bytes,7,opt,name=pubKey,proto3,oneof" json:"pubKey,omitempty"`
SignatureV2 []byte `protobuf:"bytes,8,opt,name=signatureV2,proto3,oneof" json:"signatureV2,omitempty"`
Data []byte `protobuf:"bytes,9,opt,name=data,proto3,oneof" json:"data,omitempty"`
// contains filtered or unexported fields
}
https://specs.ipfs.tech/ipns/ipns-record/#record-serialization-format
func (*IpnsRecord) Descriptor
deprecated
added in
v0.11.0
func (*IpnsRecord) Descriptor() ([]byte, []int)
Deprecated: Use IpnsRecord.ProtoReflect.Descriptor instead.
func (*IpnsRecord) GetData ¶ added in v0.11.0
func (x *IpnsRecord) GetData() []byte
func (*IpnsRecord) GetPubKey ¶ added in v0.11.0
func (x *IpnsRecord) GetPubKey() []byte
func (*IpnsRecord) GetSequence ¶ added in v0.11.0
func (x *IpnsRecord) GetSequence() uint64
func (*IpnsRecord) GetSignatureV1 ¶ added in v0.11.0
func (x *IpnsRecord) GetSignatureV1() []byte
func (*IpnsRecord) GetSignatureV2 ¶ added in v0.11.0
func (x *IpnsRecord) GetSignatureV2() []byte
func (*IpnsRecord) GetTtl ¶ added in v0.11.0
func (x *IpnsRecord) GetTtl() uint64
func (*IpnsRecord) GetValidity ¶ added in v0.11.0
func (x *IpnsRecord) GetValidity() []byte
func (*IpnsRecord) GetValidityType ¶ added in v0.11.0
func (x *IpnsRecord) GetValidityType() IpnsRecord_ValidityType
func (*IpnsRecord) GetValue ¶ added in v0.11.0
func (x *IpnsRecord) GetValue() []byte
func (*IpnsRecord) ProtoMessage ¶ added in v0.11.0
func (*IpnsRecord) ProtoMessage()
func (*IpnsRecord) ProtoReflect ¶ added in v0.11.0
func (x *IpnsRecord) ProtoReflect() protoreflect.Message
func (*IpnsRecord) Reset ¶ added in v0.11.0
func (x *IpnsRecord) Reset()
func (*IpnsRecord) String ¶ added in v0.11.0
func (x *IpnsRecord) String() string
type IpnsRecord_ValidityType ¶ added in v0.11.0
type IpnsRecord_ValidityType int32
const (
IpnsRecord_EOL IpnsRecord_ValidityType = 0
)
func (IpnsRecord_ValidityType) Descriptor ¶ added in v0.11.0
func (IpnsRecord_ValidityType) Descriptor() protoreflect.EnumDescriptor
func (IpnsRecord_ValidityType) Enum ¶ added in v0.11.0
func (x IpnsRecord_ValidityType) Enum() *IpnsRecord_ValidityType
func (IpnsRecord_ValidityType) EnumDescriptor
deprecated
added in
v0.11.0
func (IpnsRecord_ValidityType) EnumDescriptor() ([]byte, []int)
Deprecated: Use IpnsRecord_ValidityType.Descriptor instead.
func (IpnsRecord_ValidityType) Number ¶ added in v0.11.0
func (x IpnsRecord_ValidityType) Number() protoreflect.EnumNumber
func (IpnsRecord_ValidityType) String ¶ added in v0.11.0
func (x IpnsRecord_ValidityType) String() string
func (IpnsRecord_ValidityType) Type ¶ added in v0.11.0
func (IpnsRecord_ValidityType) Type() protoreflect.EnumType
Source Files
Click to show internal directories.
Click to hide internal directories.