Documentation
¶
Overview ¶
Package peer conatains some peer resolving and extracting helpers.
Index ¶
- func ToInputChannel(channel tg.InputPeerClass) (tg.InputChannelClass, bool)
- func ToInputUser(user tg.InputPeerClass) (tg.InputUserClass, bool)
- type ConstraintError
- type Entities
- func (ent Entities) Channel(id int64) (*tg.Channel, bool)
- func (ent Entities) Channels() map[int64]*tg.Channel
- func (ent Entities) Chat(id int64) (*tg.Chat, bool)
- func (ent Entities) Chats() map[int64]*tg.Chat
- func (ent Entities) ExtractPeer(peerID tg.PeerClass) (tg.InputPeerClass, error)
- func (ent Entities) Fill(users map[int64]*tg.User, chats map[int64]*tg.Chat, ...)
- func (ent Entities) FillFromResult(r EntitySearchResult)
- func (ent Entities) FillFromUpdate(uctx tg.Entities)
- func (ent Entities) User(id int64) (*tg.User, bool)
- func (ent Entities) Users() map[int64]*tg.User
- type EntitySearchResult
- type LRUResolver
- func (l *LRUResolver) Evict(key string) (tg.InputPeerClass, bool)
- func (l *LRUResolver) ResolveDomain(ctx context.Context, domain string) (tg.InputPeerClass, error)
- func (l *LRUResolver) ResolvePhone(ctx context.Context, phone string) (tg.InputPeerClass, error)
- func (l *LRUResolver) WithClock(c clock.Clock) *LRUResolver
- func (l *LRUResolver) WithExpiration(expiration time.Duration) *LRUResolver
- type Promise
- func OnlyChannel(p Promise) Promise
- func OnlyChat(p Promise) Promise
- func OnlyUser(p Promise) Promise
- func OnlyUserID(p Promise) Promise
- func Resolve(r Resolver, from string) Promise
- func ResolveDeeplink(r Resolver, u string) Promise
- func ResolveDomain(r Resolver, domain string) Promise
- func ResolvePhone(r Resolver, phone string) Promise
- type PromiseDecorator
- type Resolver
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ToInputChannel ¶ added in v0.33.0
func ToInputChannel(channel tg.InputPeerClass) (tg.InputChannelClass, bool)
ToInputChannel converts given peer to input channel if possible.
func ToInputUser ¶ added in v0.33.0
func ToInputUser(user tg.InputPeerClass) (tg.InputUserClass, bool)
ToInputUser converts given peer to input user if possible.
Types ¶
type ConstraintError ¶ added in v0.35.0
type ConstraintError struct {
Expected string
Got tg.InputPeerClass
}
ConstraintError is a peer resolve constraint error.
func (*ConstraintError) Error ¶ added in v0.35.0
func (c *ConstraintError) Error() string
Error implements error.
type Entities ¶
type Entities struct {
// contains filtered or unexported fields
}
Entities is simple peer entities storage.
func EntitiesFromResult ¶
func EntitiesFromResult(r EntitySearchResult) Entities
EntitiesFromResult fills Entities struct using given context.
func EntitiesFromUpdate ¶
EntitiesFromUpdate fills Entities struct using given context.
func NewEntities ¶
func NewEntities( users map[int64]*tg.User, chats map[int64]*tg.Chat, channels map[int64]*tg.Channel, ) Entities
NewEntities creates new Entities struct.
func (Entities) Channels ¶ added in v0.38.0
Channels returns map of channels. Notice that returned map is not a copy.
func (Entities) Chats ¶ added in v0.38.0
Chats returns map of chats. Notice that returned map is not a copy.
func (Entities) ExtractPeer ¶
ExtractPeer finds and creates InputPeerClass using given PeerClass.
func (Entities) Fill ¶
func (ent Entities) Fill( users map[int64]*tg.User, chats map[int64]*tg.Chat, channels map[int64]*tg.Channel, )
Fill adds and updates all entities from given maps.
func (Entities) FillFromResult ¶
func (ent Entities) FillFromResult(r EntitySearchResult)
FillFromResult adds and updates all entities from given result.
func (Entities) FillFromUpdate ¶
FillFromUpdate adds and updates all entities from given updates.
type EntitySearchResult ¶
type EntitySearchResult interface {
MapChats() tg.ChatClassArray
MapUsers() tg.UserClassArray
}
EntitySearchResult is abstraction for different RPC responses which contains entities.
type LRUResolver ¶
type LRUResolver struct {
// contains filtered or unexported fields
}
LRUResolver is simple decorator for Resolver to cache result in LRU.
Example (Cache) ¶
package main
import (
"context"
"fmt"
"os"
"os/signal"
"time"
"github.com/gotd/td/telegram"
"github.com/gotd/td/telegram/message"
"github.com/gotd/td/telegram/message/peer"
"github.com/gotd/td/tg"
)
func resolveLRU(ctx context.Context) error {
client, err := telegram.ClientFromEnvironment(telegram.Options{})
if err != nil {
return err
}
return client.Run(ctx, func(ctx context.Context) error {
raw := tg.NewClient(client)
resolver := peer.NewLRUResolver(peer.Plain(raw), 16).WithExpiration(time.Minute)
sender := message.NewSender(raw).WithResolver(resolver)
// "durovschat" will be resolved by Plain resolver.
if _, err := sender.Resolve("@durovschat").Dice(ctx); err != nil {
return err
}
// "durovschat" will be resolved by cache.
if _, err := sender.Resolve("https://t.me/durovschat").Darts(ctx); err != nil {
return err
}
// Evict and delete record.
resolver.Evict("durovschat")
return nil
})
}
func main() {
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
defer cancel()
if err := resolveLRU(ctx); err != nil {
_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
os.Exit(2)
}
}
Output:
func NewLRUResolver ¶
func NewLRUResolver(next Resolver, capacity int) *LRUResolver
NewLRUResolver creates new LRUResolver.
func (*LRUResolver) Evict ¶ added in v0.36.0
func (l *LRUResolver) Evict(key string) (tg.InputPeerClass, bool)
Evict deletes record from cache.
func (*LRUResolver) ResolveDomain ¶ added in v0.31.0
func (l *LRUResolver) ResolveDomain(ctx context.Context, domain string) (tg.InputPeerClass, error)
ResolveDomain implements Resolver.
func (*LRUResolver) ResolvePhone ¶ added in v0.30.0
func (l *LRUResolver) ResolvePhone(ctx context.Context, phone string) (tg.InputPeerClass, error)
ResolvePhone implements Resolver.
func (*LRUResolver) WithClock ¶ added in v0.36.0
func (l *LRUResolver) WithClock(c clock.Clock) *LRUResolver
WithClock sets clock to use when counting expiration.
func (*LRUResolver) WithExpiration ¶ added in v0.36.0
func (l *LRUResolver) WithExpiration(expiration time.Duration) *LRUResolver
WithExpiration sets expiration timeout for records in cache. If zero, expiration will be disabled. Default value is a minute.
type Promise ¶ added in v0.27.0
type Promise func(ctx context.Context) (tg.InputPeerClass, error)
Promise is a peer promise.
func OnlyChannel ¶ added in v0.30.0
OnlyChannel returns Promise which returns error if resolved peer is not a channel.
func OnlyChat ¶ added in v0.30.0
OnlyChat returns Promise which returns error if resolved peer is not a chat.
func OnlyUser ¶ added in v0.30.0
OnlyUser returns Promise which returns error if resolved peer is not a user.
func OnlyUserID ¶ added in v0.35.0
OnlyUserID returns Promise which returns error if resolved peer is not a user object with ID. Unlike OnlyUser, it returns error if resolved peer is tg.InputPeerSelf.
func Resolve ¶ added in v0.27.0
Resolve uses given string to create new peer promise. It resolves peer of message using given Resolver. Input examples:
@telegram telegram t.me/telegram https://t.me/telegram tg:resolve?domain=telegram tg://resolve?domain=telegram +13115552368 +1 (311) 555-0123 +1 311 555-6162 13115556162
func ResolveDeeplink ¶ added in v0.27.0
ResolveDeeplink uses given deeplink to create new peer promise. Deeplink is a URL like https://t.me/telegram. It resolves peer of message using given Resolver. Input examples:
t.me/telegram https://t.me/telegram tg:resolve?domain=telegram tg://resolve?domain=telegram
func ResolveDomain ¶ added in v0.27.0
ResolveDomain uses given domain to create new peer promise. It resolves peer of message using given Resolver. Can has prefix with @ or not. Input examples:
@telegram telegram
func ResolvePhone ¶ added in v0.30.0
ResolvePhone uses given phone to create new peer promise. It resolves peer of message using given Resolver. Input example:
+13115552368 +1 (311) 555-0123 +1 311 555-6162 13115556162
Note that Telegram represents phone numbers according to the E.164 standard without the plus sign (”+”) prefix. The resolver therefore takes an easy route and just deletes any non-digit symbols from phone number string.
type PromiseDecorator ¶ added in v0.30.0
PromiseDecorator is a decorator of peer promise.
type Resolver ¶
type Resolver interface {
ResolveDomain(ctx context.Context, domain string) (tg.InputPeerClass, error)
ResolvePhone(ctx context.Context, phone string) (tg.InputPeerClass, error)
}
Resolver is an abstraction to resolve domains and Telegram deeplinks.
func DefaultResolver ¶
DefaultResolver creates and returns default resolver.
func SingleflightResolver ¶ added in v0.36.0
SingleflightResolver is a simple resolver decorator which prevents duplicate resolve calls.
Source Files