types

Documentation

Overview

Package types implements all the types used by the Friends protocol

Package types implements all the types used by the Friends protocol

Index

• type FriendData
  • func NewFriendData() *FriendData
  • func (fd *FriendData) Copy() types.RVType
  • func (fd *FriendData) Equals(o types.RVType) bool
  • func (fd *FriendData) ExtractFrom(readable types.Readable) error
  • func (fd *FriendData) FormatToString(indentationLevel int) string
  • func (fd *FriendData) String() string
  • func (fd *FriendData) WriteTo(writable types.Writable)
• type RelationshipData
  • func NewRelationshipData() *RelationshipData
  • func (rd *RelationshipData) Copy() types.RVType
  • func (rd *RelationshipData) Equals(o types.RVType) bool
  • func (rd *RelationshipData) ExtractFrom(readable types.Readable) error
  • func (rd *RelationshipData) FormatToString(indentationLevel int) string
  • func (rd *RelationshipData) String() string
  • func (rd *RelationshipData) WriteTo(writable types.Writable)

Types

type FriendData

type FriendData struct {
	types.Structure
	PID            *types.PID
	StrName        *types.String
	ByRelationship *types.PrimitiveU8
	UIDetails      *types.PrimitiveU32
	StrStatus      *types.String
}

FriendData is a type within the Friends protocol

func NewFriendData

func NewFriendData() *FriendData

NewFriendData returns a new FriendData

func (*FriendData) Copy

func (fd *FriendData) Copy() types.RVType

Copy returns a new copied instance of FriendData

func (*FriendData) Equals

func (fd *FriendData) Equals(o types.RVType) bool

Equals checks if the given FriendData contains the same data as the current FriendData

func (*FriendData) ExtractFrom

func (fd *FriendData) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendData from the given readable

func (*FriendData) FormatToString

func (fd *FriendData) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendData using the provided indentation level

func (*FriendData) String

func (fd *FriendData) String() string

String returns the string representation of the FriendData

func (*FriendData) WriteTo

func (fd *FriendData) WriteTo(writable types.Writable)

WriteTo writes the FriendData to the given writable

type RelationshipData

type RelationshipData struct {
	types.Structure
	PID            *types.PrimitiveU32
	StrName        *types.String
	ByRelationship *types.PrimitiveU8
	UIDetails      *types.PrimitiveU32
	ByStatus       *types.PrimitiveU8
}

RelationshipData is a type within the Friends protocol

func NewRelationshipData

func NewRelationshipData() *RelationshipData

NewRelationshipData returns a new RelationshipData

func (*RelationshipData) Copy

func (rd *RelationshipData) Copy() types.RVType

Copy returns a new copied instance of RelationshipData

func (*RelationshipData) Equals

func (rd *RelationshipData) Equals(o types.RVType) bool

Equals checks if the given RelationshipData contains the same data as the current RelationshipData

func (*RelationshipData) ExtractFrom

func (rd *RelationshipData) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the RelationshipData from the given readable

func (*RelationshipData) FormatToString

func (rd *RelationshipData) FormatToString(indentationLevel int) string

FormatToString pretty-prints the RelationshipData using the provided indentation level

func (*RelationshipData) String

func (rd *RelationshipData) String() string

String returns the string representation of the RelationshipData

func (*RelationshipData) WriteTo

func (rd *RelationshipData) WriteTo(writable types.Writable)

WriteTo writes the RelationshipData to the given writable