Documentation
¶
Overview ¶
Package bbolt contains gotd storage implementations using etcd bbolt.
Index ¶
- type Credentials
- type PeerStorage
- func (s PeerStorage) Add(ctx context.Context, value storage.Peer) error
- func (s PeerStorage) Assign(ctx context.Context, key string, value storage.Peer) error
- func (s PeerStorage) Find(ctx context.Context, key storage.PeerKey) (p storage.Peer, rerr error)
- func (s PeerStorage) Iterate(ctx context.Context) (storage.PeerIterator, error)
- func (s PeerStorage) Resolve(ctx context.Context, key string) (p storage.Peer, rerr error)
- type SessionStorage
- type State
- func (s *State) ForEachChannels(ctx context.Context, userID int64, ...) error
- func (s *State) GetChannelPts(_ context.Context, userID, channelID int64) (pts int, found bool, err error)
- func (s *State) GetState(_ context.Context, userID int64) (state updates.State, found bool, err error)
- func (s *State) SetChannelPts(_ context.Context, userID, channelID int64, pts int) error
- func (s *State) SetDate(_ context.Context, userID int64, date int) error
- func (s *State) SetDateSeq(_ context.Context, userID int64, date, seq int) error
- func (s *State) SetPts(_ context.Context, userID int64, pts int) error
- func (s *State) SetQts(_ context.Context, userID int64, qts int) error
- func (s *State) SetSeq(_ context.Context, userID int64, seq int) error
- func (s *State) SetState(_ context.Context, userID int64, state updates.State) error
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Credentials ¶
type Credentials struct {
kv.Credentials
}
Credentials stores user credentials to bbolt.
Example ¶
package main
import (
"context"
"fmt"
"os"
"os/signal"
"github.com/go-faster/errors"
bboltdb "go.etcd.io/bbolt"
"github.com/gotd/td/telegram"
tgauth "github.com/gotd/td/telegram/auth"
"github.com/gotd/contrib/auth"
"github.com/gotd/contrib/auth/terminal"
"github.com/gotd/contrib/bbolt"
)
func bboltAuth(ctx context.Context) error {
db, err := bboltdb.Open("bbolt.db", 0666, &bboltdb.Options{}) // nolint:gocritic
if err != nil {
return errors.Errorf("create bbolt storage: %w", err)
}
cred := bbolt.NewCredentials(db, []byte("bucket")).
WithPhoneKey("phone").
WithPasswordKey("password")
client, err := telegram.ClientFromEnvironment(telegram.Options{})
if err != nil {
return errors.Errorf("create client: %w", err)
}
return client.Run(ctx, func(ctx context.Context) error {
return client.Auth().IfNecessary(
ctx,
tgauth.NewFlow(auth.Build(cred, terminal.OS()), tgauth.SendCodeOptions{}),
)
})
}
func main() {
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
defer cancel()
if err := bboltAuth(ctx); err != nil {
_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
os.Exit(1)
}
}
func NewCredentials ¶
func NewCredentials(db *bbolt.DB, bucket []byte) Credentials
NewCredentials creates new Credentials.
type PeerStorage ¶
type PeerStorage struct {
// contains filtered or unexported fields
}
PeerStorage is a peer storage based on pebble.
func NewPeerStorage ¶
func NewPeerStorage(db *bbolt.DB, bucket []byte) *PeerStorage
NewPeerStorage creates new peer storage using bbolt.
func (PeerStorage) Assign ¶
Assign adds given peer to the storage and associate it to the given key.
func (PeerStorage) Iterate ¶
func (s PeerStorage) Iterate(ctx context.Context) (storage.PeerIterator, error)
Iterate creates and returns new PeerIterator.
type SessionStorage ¶
SessionStorage is a MTProto session bbolt storage.
Example ¶
package main
import (
"context"
"fmt"
"os"
"os/signal"
"github.com/go-faster/errors"
bboltdb "go.etcd.io/bbolt"
"github.com/gotd/td/telegram"
"github.com/gotd/contrib/bbolt"
)
func bboltStorage(ctx context.Context) error {
db, err := bboltdb.Open("bbolt.db", 0666, &bboltdb.Options{}) // nolint:gocritic
if err != nil {
return errors.Errorf("create bbolt storage: %w", err)
}
storage := bbolt.NewSessionStorage(db, "session", []byte("bucket"))
client, err := telegram.ClientFromEnvironment(telegram.Options{
SessionStorage: storage,
})
if err != nil {
return errors.Errorf("create client: %w", err)
}
return client.Run(ctx, func(ctx context.Context) error {
_, err := client.Auth().Bot(ctx, os.Getenv("BOT_TOKEN"))
return err
})
}
func main() {
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
defer cancel()
if err := bboltStorage(ctx); err != nil {
_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
os.Exit(1)
}
}
func NewSessionStorage ¶
func NewSessionStorage(db *bbolt.DB, key string, bucket []byte) SessionStorage
NewSessionStorage creates new SessionStorage.
type State ¶ added in v0.19.0
type State struct {
// contains filtered or unexported fields
}
State is updates.StateStorage implementation using bbolt.
func NewStateStorage ¶ added in v0.19.0
NewStateStorage creates new state storage over bbolt.
Caller is responsible for db.Close() invocation.