package session

Import Path
	github.com/gotd/td/session (on go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	  d session.go
		Package session implements session storage.

	    storage_file.go
	    storage_mem.go
	    tdesktop.go
	    telethon.go
Package-Level Type Names (total 7, in which 6 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Config (struct)
		Config is subset of tg.Config.

		Fields (total 10, all are exported)
			BlockedMode bool
				Indicates that telegram is probably censored by governments/ISPs in the current region

			DCOptions []tg.DCOption
				DC IP list

			DCTxtDomainName string
				Domain name for fetching encrypted DC list from DNS TXT record

			Date int
				Current date at the server

			Expires int
				Expiration date of this config: when it expires it'll have to be refetched using help
				getConfig¹
				
				Links:
				 1) https://core.telegram.org/method/help.getConfig

			ForceTryIpv6 bool
				Whether to forcefully try connecting using IPv6 dcOptions¹
				
				Links:
				 1) https://core.telegram.org/type/DcOption

			TestMode bool
				Whether we're connected to the test DCs

			ThisDC int
				ID of the DC that returned the reply

			TmpSessions int
				Temporary passport¹ sessions
				
				Links:
				 1) https://core.telegram.org/passport
				
				Use SetTmpSessions and GetTmpSessions helpers.

			WebfileDCID int
				DC ID to use to download webfiles¹
				
				Links:
				 1) https://core.telegram.org/api/files#downloading-webfiles

		Methods (only one, which is exported)
			( Config) TG() tg.Config
				TG returns tg.Config from Config.
				
				Note that config is the subset of tg.Config, so some fields will be unset.

		As Outputs Of (at least 2, in which 1 is exported)
			func ConfigFromTG(c tg.Config) Config
			/* at least one unexported ... *//* at least one unexported: */
			func mapConfig(mainDC int, cfg tdesktop.MTPConfig) Config

	 type Data (struct)
		Data of session.

		Fields (total 6, all are exported)
			Addr string
			AuthKey []byte
			AuthKeyID []byte
			Config Config
			DC int
			Salt int64
		As Outputs Of (at least 4, in which 3 are exported)
			func TDesktopSession(account tdesktop.Account) (*Data, error)
			func TelethonSession(hx string) (*Data, error)
			func (*Loader).Load(ctx context.Context) (*Data, error)
			/* at least one unexported ... *//* at least one unexported: */
			func decodeStringSession(data []byte) (*Data, error)
		As Inputs Of (at least one exported)
			func (*Loader).Save(ctx context.Context, data *Data) error

	 type FileStorage (struct)
		FileStorage implements SessionStorage for file system as file
		stored in Path.

		Fields (total 2, in which 1 is exported)
			Path string
			/* one unexported ... *//* one unexported: */
			mux sync.Mutex
		Methods (total 2, both are exported)
			(*FileStorage) LoadSession(_ context.Context) ([]byte, error)
				LoadSession loads session from file.

			(*FileStorage) StoreSession(_ context.Context, data []byte) error
				StoreSession stores session to file.

		Implements (at least one exported)
			*FileStorage : Storage

	 type Loader (struct)
		Loader wraps Storage implementing Data (un-)marshaling.

		Fields (only one, which is exported)
			Storage Storage
		Methods (total 2, both are exported)
			(*Loader) Load(ctx context.Context) (*Data, error)
				Load loads Data from Storage.

			(*Loader) Save(ctx context.Context, data *Data) error
				Save saves Data to Storage.

		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*Loader : github.com/gotd/td/telegram.clientStorage

	 type Storage (interface)
		Storage is secure persistent storage for client session.
		
		NB: Implementation security is important, attacker can abuse it not only for
		connecting as authenticated user or bot, but even decrypting previous
		messages in some situations.

		Methods (total 2, both are exported)
			( Storage) LoadSession(ctx context.Context) ([]byte, error)
			( Storage) StoreSession(ctx context.Context, data []byte) error
		Implemented By (at least 2, both are exported)
			*FileStorage
			*StorageMemory

	 type StorageMemory (struct)
		StorageMemory implements in-memory session storage.
		Goroutine-safe.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			data []byte
			mux sync.RWMutex
		Methods (total 6, all are exported)
			(*StorageMemory) Bytes(to []byte) ([]byte, error)
				Bytes appends raw session data to the given slice.
				Returns ErrNotFound if storage is nil or if underlying session is empty.

			(*StorageMemory) Clone() *StorageMemory
				Clone creates a clone of existing StorageMemory,

			(*StorageMemory) Dump(w io.Writer) error
				Dump dumps raw session data to the given writer.
				Returns ErrNotFound if storage is nil or if underlying session is empty.

			(*StorageMemory) LoadSession(context.Context) ([]byte, error)
				LoadSession loads session from memory.

			(*StorageMemory) StoreSession(ctx context.Context, data []byte) error
				StoreSession stores session to memory.

			(*StorageMemory) WriteFile(name string, perm os.FileMode) error
				WriteFile dumps raw session data to the named file, creating it if necessary.
				Returns ErrNotFound if storage is nil or if underlying session is empty.

		Implements (at least one exported)
			*StorageMemory : Storage
		As Outputs Of (at least one exported)
			func (*StorageMemory).Clone() *StorageMemory

	/* one unexported ... *//* one unexported: */
	 type jsonData (struct)

		Fields (total 2, both are exported)
			Data Data
			Version int


Package-Level Functions (total 6, in which 3 are exported)

	 func ConfigFromTG(c tg.Config) Config
		ConfigFromTG converts tg.Config to Config.
		
		Note that Config is the subset of tg.Config, so data loss is possible.

	 func TDesktopSession(account tdesktop.Account) (*Data, error)
		TDesktopSession converts TDesktop's Account to Data.

	 func TelethonSession(hx string) (*Data, error)
		TelethonSession decodes Telethon's StringSession string to the Data.
		Notice that Telethon does not save tg.Config and server salt.
		
		See https://docs.telethon.dev/en/latest/modules/sessions.html#telethon.sessions.string.StringSession.
		
		See https://github.com/LonamiWebs/Telethon/blob/master/telethon/sessions/string.py#L29-L46.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func decodeStringSession(data []byte) (*Data, error)
	 func findDCAddr(list []tg.DCOption, dcID int) string
	 func mapConfig(mainDC int, cfg tdesktop.MTPConfig) Config
Package-Level Variables (only one, which is exported)

	  var ErrNotFound error
		ErrNotFound means that session is not found in storage.


Package-Level Constants (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const latestTelethonVersion byte = 49
		https://github.com/LonamiWebs/Telethon/blob/master/telethon/sessions/string.py#L11

	const latestVersion = 1

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.