7 releases (breaking)

0.6.0 May 3, 2024
0.5.1 Nov 18, 2023
0.4.0 Oct 14, 2022
0.3.0 May 5, 2021
0.1.0 Jan 31, 2020

#436 in Encoding

Download history 25/week @ 2024-02-12 54/week @ 2024-02-19 73/week @ 2024-02-26 35/week @ 2024-03-04 77/week @ 2024-03-11 44/week @ 2024-03-18 45/week @ 2024-03-25 104/week @ 2024-04-01 314/week @ 2024-04-08 152/week @ 2024-04-15 55/week @ 2024-04-22 265/week @ 2024-04-29 79/week @ 2024-05-06 49/week @ 2024-05-13 114/week @ 2024-05-20 93/week @ 2024-05-27

353 downloads per month
Used in 7 crates (5 directly)

MIT/Apache

72KB
582 lines

grammers-tl-types

This library provides Rust struct and enum types representing the definitions from the Type Language build-time input files.

In addition, each type has an impl on Serializable and Deserializable, the former serializes instances into byte arrays as described by the section on Binary Data Serialization, and the latter deserializes them.


lib.rs:

This library contains the Rust definitions for Telegram's types and functions in the form of struct and enum. All of them implement Serializable, and by default only types implement Deserializable.

If you're here because you want to invoke the "raw API" methods Telegram has to offer, use the search or read through the available functions to find out what "parameters" such remote call needs. Then, create an instance of it and pass it to some higher level library that can talk with Telegram's servers.

To preserve compatibility with older applications, the API has a concept of "layers", where new layers can change, remove or add new definitions. The LAYER constant indicates which of the many layers was used to generate the definitions present in this version of this crate.

Usage

The primary purpose is using these definitions to create requests (known as functions) which can be serialized and sent to Telegram. Note that this crate has no way to "invoke" any of these requests, this is to be done by a higher-level crate.

All of the requests implement RemoteCall. This trait's associated type indicates what type the response from Telegram will be when invoked.

After opening one of the many types, you can inspect their fields to figure out what data Telegram will return.

Features

The default feature set is intended to make the use of the library comfortable, and not intended to be minimal in code size. If you need a smaller library or are concerned about build-times, consider disabling some of the default features.

The default feature set includes:

  • impl-debug.
  • impl-from-enum.
  • impl-from-type.
  • tl-api.

The available features are:

  • deserializable-functions: implements Deserializable for functions. This might be of interest for server implementations, which need to deserialize the client's requests, but is otherwise not required.

  • impl-debug: implements Debug for the generated code.

  • impl-from-enum: implements TryFrom<Enum> for Type.

  • impl-from-type: implements From<Type> for Enum.

  • tl-api: generates code for the api.tl. This is what high-level libraries often need.

  • tl-mtproto: generates code for the mtproto.tl. Only useful for low-level libraries.

No runtime deps