meta

Documentation

Overview

Code generated by vktl/cmd/tlgen2; DO NOT EDIT.

Index

• func GetTLName(tag uint32, notFoundName string) string
• func SchemaCommit() string
• func SchemaGenerator() string
• func SchemaTimestamp() uint32
• func SchemaURL() string
• func SetGlobalFactoryCreateForEnumElement(itemTag uint32)
• func SetGlobalFactoryCreateForEnumElementBytes(itemTag uint32)
• func SetGlobalFactoryCreateForFunction(itemTag uint32, createObject func() Object, createFunction func() Function, ...)
• func SetGlobalFactoryCreateForFunctionBytes(itemTag uint32, createObject func() Object, createFunction func() Function, ...)
• func SetGlobalFactoryCreateForObject(itemTag uint32, createObject func() Object)
• func SetGlobalFactoryCreateForObjectBytes(itemTag uint32, createObject func() Object)
• type Function
  • func CreateFunction(tag uint32) Function
  • func CreateFunctionBytes(tag uint32) Function
  • func CreateFunctionFromName(name string) Function
  • func CreateFunctionFromNameBytes(name string) Function
• type Object
  • func CreateObject(tag uint32) Object
  • func CreateObjectBytes(tag uint32) Object
  • func CreateObjectFromName(name string) Object
  • func CreateObjectFromNameBytes(name string) Object
• type TLItem
  • func FactoryItemByTLName(name string) *TLItem
  • func FactoryItemByTLTag(tag uint32) *TLItem
  • func GetAllTLItems() []TLItem
  • func (item TLItem) AnnotationRead() bool
  • func (item TLItem) AnnotationReadwrite() bool
  • func (item TLItem) CreateFunction() Function
  • func (item TLItem) CreateFunctionLong() Function
  • func (item TLItem) CreateObject() Object
  • func (item *TLItem) FillRandom(rg *basictl.RandGenerator)
  • func (item TLItem) HasFunctionLong() bool
  • func (item TLItem) HasUnionTypesInArguments() bool
  • func (item TLItem) HasUnionTypesInResult() bool
  • func (item TLItem) IsFunction() bool
  • func (item *TLItem) MarshalJSON() ([]byte, error)
  • func (item *TLItem) Read(w []byte) ([]byte, error)
  • func (item *TLItem) ReadBoxed(w []byte) ([]byte, error)
  • func (item *TLItem) ReadJSON(legacyTypeNames bool, in *basictl.JsonLexer) error
  • func (item *TLItem) Reset()
  • func (item TLItem) String() string
  • func (item TLItem) TLName() string
  • func (item TLItem) TLTag() uint32
  • func (item *TLItem) UnmarshalJSON(b []byte) error
  • func (item *TLItem) Write(w []byte) []byte
  • func (item *TLItem) WriteBoxed(w []byte) []byte
  • func (item *TLItem) WriteBoxedGeneral(w []byte) ([]byte, error)
  • func (item *TLItem) WriteGeneral(w []byte) ([]byte, error)
  • func (item *TLItem) WriteJSON(w []byte) []byte
  • func (item *TLItem) WriteJSONGeneral(w []byte) (_ []byte, err error)

Functions

func GetTLName

func GetTLName(tag uint32, notFoundName string) string

for quick one-liners

func SchemaCommit

func SchemaCommit() string

func SchemaGenerator

func SchemaGenerator() string

func SchemaTimestamp

func SchemaTimestamp() uint32

func SchemaURL

func SchemaURL() string

func SetGlobalFactoryCreateForEnumElement

func SetGlobalFactoryCreateForEnumElement(itemTag uint32)

func SetGlobalFactoryCreateForEnumElementBytes

func SetGlobalFactoryCreateForEnumElementBytes(itemTag uint32)

func SetGlobalFactoryCreateForFunction

func SetGlobalFactoryCreateForFunction(itemTag uint32, createObject func() Object, createFunction func() Function, createFunctionLong func() Function)

func SetGlobalFactoryCreateForFunctionBytes

func SetGlobalFactoryCreateForFunctionBytes(itemTag uint32, createObject func() Object, createFunction func() Function, createFunctionLong func() Function)

func SetGlobalFactoryCreateForObject

func SetGlobalFactoryCreateForObject(itemTag uint32, createObject func() Object)

func SetGlobalFactoryCreateForObjectBytes

func SetGlobalFactoryCreateForObjectBytes(itemTag uint32, createObject func() Object)

Types

type Function

type Function interface {
	Object

	ReadResultWriteResultJSON(r []byte, w []byte) ([]byte, []byte, error) // combination of ReadResult(r) + WriteResultJSON(w). Returns new r, new w, plus error
	ReadResultJSONWriteResult(r []byte, w []byte) ([]byte, []byte, error) // combination of ReadResultJSON(r) + WriteResult(w). Returns new r, new w, plus error

	// For transcoding short-long version during Long ID and newTypeNames transition
	ReadResultWriteResultJSONOpt(newTypeNames bool, short bool, r []byte, w []byte) ([]byte, []byte, error)
}

func CreateFunction

func CreateFunction(tag uint32) Function

func CreateFunctionBytes

func CreateFunctionBytes(tag uint32) Function

func CreateFunctionFromName

func CreateFunctionFromName(name string) Function

name can be in any of 3 forms "ch_proxy.insert#7cf362ba", "ch_proxy.insert" or "#7cf362ba"

func CreateFunctionFromNameBytes

func CreateFunctionFromNameBytes(name string) Function

name can be in any of 3 forms "ch_proxy.insert#7cf362ba", "ch_proxy.insert" or "#7cf362ba"

type Object

type Object interface {
	TLName() string // returns type's TL name. For union, returns constructor name depending on actual union value
	TLTag() uint32  // returns type's TL tag. For union, returns constructor tag depending on actual union value
	String() string // returns type's representation for debugging (JSON for now)

	FillRandom(rg *basictl.RandGenerator)
	Read(w []byte) ([]byte, error)              // reads type's bare TL representation by consuming bytes from the start of w and returns remaining bytes, plus error
	ReadBoxed(w []byte) ([]byte, error)         // same as Read, but reads/checks TLTag first (this method is general version of Write, use it only when you are working with interface)
	WriteGeneral(w []byte) ([]byte, error)      // appends bytes of type's bare TL representation to the end of w and returns it, plus error
	WriteBoxedGeneral(w []byte) ([]byte, error) // same as Write, but writes TLTag first (this method is general version of WriteBoxed, use it only when you are working with interface)

	MarshalJSON() ([]byte, error) // returns type's JSON representation, plus error
	UnmarshalJSON([]byte) error   // reads type's JSON representation

	ReadJSON(legacyTypeNames bool, in *basictl.JsonLexer) error
	WriteJSONGeneral(w []byte) ([]byte, error) // like MarshalJSON, but appends to w and returns it (this method is general version of WriteBoxed, use it only when you are working with interface)
}

We can create only types which have zero type arguments and zero nat arguments

func CreateObject

func CreateObject(tag uint32) Object

func CreateObjectBytes

func CreateObjectBytes(tag uint32) Object

func CreateObjectFromName

func CreateObjectFromName(name string) Object

name can be in any of 3 forms "ch_proxy.insert#7cf362ba", "ch_proxy.insert" or "#7cf362ba"

func CreateObjectFromNameBytes

func CreateObjectFromNameBytes(name string) Object

name can be in any of 3 forms "ch_proxy.insert#7cf362ba", "ch_proxy.insert" or "#7cf362ba"

type TLItem

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

func FactoryItemByTLName

func FactoryItemByTLName(name string) *TLItem

func FactoryItemByTLTag

func FactoryItemByTLTag(tag uint32) *TLItem

func GetAllTLItems

func GetAllTLItems() []TLItem

func (TLItem) AnnotationRead

func (item TLItem) AnnotationRead() bool

Annotations

func (TLItem) AnnotationReadwrite

func (item TLItem) AnnotationReadwrite() bool

func (TLItem) CreateFunction

func (item TLItem) CreateFunction() Function

func (TLItem) CreateFunctionLong

func (item TLItem) CreateFunctionLong() Function

func (TLItem) CreateObject

func (item TLItem) CreateObject() Object

func (*TLItem) FillRandom

func (item *TLItem) FillRandom(rg *basictl.RandGenerator)

func (TLItem) HasFunctionLong

func (item TLItem) HasFunctionLong() bool

For transcoding short-long version during Long ID transition

func (TLItem) HasUnionTypesInArguments

func (item TLItem) HasUnionTypesInArguments() bool

func (TLItem) HasUnionTypesInResult

func (item TLItem) HasUnionTypesInResult() bool

func (TLItem) IsFunction

func (item TLItem) IsFunction() bool

func (*TLItem) MarshalJSON

func (item *TLItem) MarshalJSON() ([]byte, error)

func (*TLItem) Read

func (item *TLItem) Read(w []byte) ([]byte, error)

func (*TLItem) ReadBoxed

func (item *TLItem) ReadBoxed(w []byte) ([]byte, error)

func (*TLItem) ReadJSON

func (item *TLItem) ReadJSON(legacyTypeNames bool, in *basictl.JsonLexer) error

func (*TLItem) Reset

func (item *TLItem) Reset()

TLItem serves as a single type for all enum values

func (TLItem) String

func (item TLItem) String() string

func (TLItem) TLName

func (item TLItem) TLName() string

func (TLItem) TLTag

func (item TLItem) TLTag() uint32

func (*TLItem) UnmarshalJSON

func (item *TLItem) UnmarshalJSON(b []byte) error

func (*TLItem) Write

func (item *TLItem) Write(w []byte) []byte

func (*TLItem) WriteBoxed

func (item *TLItem) WriteBoxed(w []byte) []byte

func (*TLItem) WriteBoxedGeneral

func (item *TLItem) WriteBoxedGeneral(w []byte) ([]byte, error)

func (*TLItem) WriteGeneral

func (item *TLItem) WriteGeneral(w []byte) ([]byte, error)

func (*TLItem) WriteJSON

func (item *TLItem) WriteJSON(w []byte) []byte

func (*TLItem) WriteJSONGeneral

func (item *TLItem) WriteJSONGeneral(w []byte) (_ []byte, err error)