helpers

Documentation

Overview

Package helpers contains some common helping functions.

Index

• Constants
• func AsFloodWait(err error) (d time.Duration, ok bool)
• func ConvertUpdateShortChatMessage(u *tg.UpdateShortChatMessage) *tg.UpdateShort
• func ConvertUpdateShortMessage(u *tg.UpdateShortMessage) *tg.UpdateShort
• func ConvertUpdateShortSentMessage(u *tg.UpdateShortSentMessage) *tg.UpdateShort
• func FloodWait(ctx context.Context, err error) (bool, error)

Constants

const (
	// Use upload.saveBigFilePart in case the full size of the file is more than 10 MB
	// and upload.saveFilePart for smaller files
	BigFileLimit = 10 * 1024 * 1024 // 10 MB

	// Each part should have a sequence number, file_part, with a value ranging from 0 to 3,999.
	PartsLimit = 3999

	// `part_size % 1024 = 0` (divisible by 1KB)
	PaddingPartSize = 1024
	// `524288 % part_size = 0` (512KB must be evenly divisible by part_size)
	MaximumPartSize = 524288
)

https://core.telegram.org/api/files#uploading-files

const ErrFloodWait = "FLOOD_WAIT"

ErrFloodWait is error type of "FLOOD_WAIT" error.

Functions

func AsFloodWait

func AsFloodWait(err error) (d time.Duration, ok bool)

AsFloodWait returns wait duration and true boolean if err is the "FLOOD_WAIT" error.

Client should wait for that duration before issuing new requests with same method.

func ConvertUpdateShortChatMessage

func ConvertUpdateShortChatMessage(u *tg.UpdateShortChatMessage) *tg.UpdateShort

ConvertUpdateShortChatMessage converts UpdateShortChatMessage to UpdateShort.

func ConvertUpdateShortMessage

func ConvertUpdateShortMessage(u *tg.UpdateShortMessage) *tg.UpdateShort

ConvertUpdateShortMessage converts UpdateShortMessage to UpdateShort.

func ConvertUpdateShortSentMessage

func ConvertUpdateShortSentMessage(u *tg.UpdateShortSentMessage) *tg.UpdateShort

ConvertUpdateShortSentMessage converts UpdateShortSentMessage to UpdateShort.

func FloodWait

func FloodWait(ctx context.Context, err error) (bool, error)

FloodWait sleeps required duration and true if err is FLOOD_WAIT or false and context or original error otherwise.