aboutsummaryrefslogtreecommitdiff
path: root/src/utils/builder
Commit message (Collapse)AuthorAgeFilesLines
* Restructure modulesZeyla Hellyer2017-05-2211-1332/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Modules are now separated into a fashion where the library can be used for most use cases, without needing to compile the rest. The core of serenity, with no features enabled, contains only the struct (model) definitions, constants, and prelude. Models do not have most functions compiled in, as that is separated into the `model` feature. The `client` module has been split into 3 modules: `client`, `gateway`, and `http`. `http` contains functions to interact with the REST API. `gateway` contains the Shard to interact with the gateway, requiring `http` for retrieving the gateway URL. `client` requires both of the other features and acts as an abstracted interface over both the gateway and REST APIs, handling the event loop. The `builder` module has been separated from `utils`, and can now be optionally compiled in. It and the `http` feature are required by the `model` feature due to a large number of methods requiring access to them. `utils` now contains a number of utilities, such as the Colour struct, the `MessageBuilder`, and mention parsing functions. Each of the original `ext` modules are still featured, with `cache` not requiring any feature to be enabled, `framework` requiring the `client`, `model`, and `utils`, and `voice` requiring `gateway`. In total the features and their requirements are: - `builder`: none - `cache`: none - `client`: `gateway`, `http` - `framework`: `client`, `model`, `utils` - `gateway`: `http` - `http`: none - `model`: `builder`, `http` - `utils`: none - `voice`: `gateway` The default features are `builder`, `cache`, `client`, `framework`, `gateway`, `model`, `http`, and `utils`. To help with forwards compatibility, modules have been re-exported from their original locations.
* Reasonably derive Debug on itemsZeyla Hellyer2017-05-2210-14/+14
|
* Use constant for preset permissionsZeyla Hellyer2017-05-021-2/+2
| | | | | | | | Instead of having methods which return a preset value, use constants since the actual values are themselves constant. Deprecate the previous methods and move documentation to the new constants.
* Switch to using serde for deserializationZeyla Hellyer2017-04-119-198/+268
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current build system is rudimentary, incomplete, and rigid, offering little in the way of customizing decoding options. To solve this, switch to using serde-derive with custom Deserialization implementations. This allows very simple deserialization when special logic does not need to be applied, yet allows us to implement our own deserialization logic when required. The problem with the build system was that it built enums and structs from YAML files. This is not so good, because it requires creating a custom build system (which was rudimentary), creating "special struct configs" when logic needed to be ever so slightly extended (rigid), and if special logic needed to be applied, a custom deserialization method would have been needed to be made anyway (incomplete). To solve this, switch to serde-derive and implementing Deserialize ourselves where required. This reduces YAML definitions that might look like: ```yaml --- name: Group description: > A group channel, potentially including other users, separate from a [`Guild`]. [`Guild`]: struct.Guild.html fields: - name: channel_id description: The Id of the group channel. from: id type: ChannelId - name: icon description: The optional icon of the group channel. optional: true type: string - name: last_message_id description: The Id of the last message sent. optional: true type: MessageId - name: last_pin_timestamp description: Timestamp of the latest pinned message. optional: true type: string - name: name description: The name of the group channel. optional: true type: string - name: owner_id description: The Id of the group channel creator. type: UserId - name: recipients description: Group channel's members. custom: decode_users t: UserId, Arc<RwLock<User>> type: hashmap ``` to: ```rs /// A group channel - potentially including other [`User`]s - separate from a /// [`Guild`]. /// /// [`Guild`]: struct.Guild.html /// [`User`]: struct.User.html pub struct Group { /// The Id of the group channel. #[serde(rename="id")] pub channel_id: ChannelId, /// The optional icon of the group channel. pub icon: Option<String>, /// The Id of the last message sent. pub last_message_id: Option<MessageId>, /// Timestamp of the latest pinned message. pub last_pin_timestamp: Option<String>, /// The name of the group channel. pub name: Option<String>, /// The Id of the group owner. pub owner_id: UserId, /// A map of the group's recipients. #[serde(deserialize_with="deserialize_users")] pub recipients: HashMap<UserId, Arc<RwLock<User>>>, } ``` This is much simpler and does not have as much boilerplate. There should not be any backwards incompatible changes other than the old, public - yet undocumented (and hidden from documentation) - decode methods being removed. Due to the nature of this commit, field names may be incorrect, and will need to be corrected as deserialization errors are found.
* Remove selfbot supportZeyla Hellyer2017-04-053-322/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | While selfbots have always been "roughly tolerated", lately they have been tolerated to less of a degree. The simple answer is to no longer support selfbots in any form. This is done for a few of reasons: 1) in anticipation of selfbots no longer being tolerated; 2) there are few reasons why one should make a selfbot in Rust and not a scripting language; 3) there are alternatives (i.e. discord-rs) that still support userbots. Selfbots are simply not a goal of the maintainer of serenity. Upgrade path: Don't use selfbots with serenity. Use discord-rs instead. The following has been removed: Enums: - `RelationshipType` Structs: - `FriendSourceFlags` - `ReadState` - `Relationship` - `SearchResult` - `SuggestionReason` - `Tutorial` - `UserConnection` - `UserGuildSettings` - `UserSettings` Removed the following fields: - `CurrentUser::mobile` - Ready::{ analytics_token, experiments, friend_suggestion_count, notes, read_state, relationships, tutorial, user_guild_settings, user_settings, } Removed the following methods: - `Client::login_user` Deprecated `Client::login_bot` in favour of `Client::login`. Removed `client::LoginType`. The following no longer take a `login_type` parameter: - `Context::new` - `Shard::new` `Shard::sync_guilds` has been removed. The `client::Error::{InvalidOperationAsBot, InvalidOperationAsUser}` variants have been removed. The following event handlers on `Client` have been removed: - `on_friend_suggestion_create` - `on_friend_suggestion_delete` - `on_relationship_add` - `on_relationship_remove` - `on_user_guild_settings_update` - `on_note_update` - `on_user_settings_update` The following `client::rest` functions have been removed: - `ack_message` - `edit_note` - `get_user_connections` - `search_channel_messages` - `search_guild_messages` The following `client::rest::ratelimiting::Route` variants have been removed: - `ChannelsIdMessagesSearch` - `GuildsIdMessagesSearch` - `UsersMeConnections` The following fields on `ext::cache::Cache` have been removed: - `guild_settings` - `relationships` - `settings` while the following methods have also been removed: - `update_with_relationship_add` - `update_with_relationship_remove` - `update_with_user_guild_settings_update` - `update_with_user_note_update` - `update_with_user_settings_update` The following methods have been removed across models: - `ChannelId::{ack, search}` - `Channel::{ack, search}` - `Group::{ack, search}` - `GuildChannel::{ack, search}` - `GuildId::{search, search_channels}` - `Guild::{search, search_channels}` - `Message::ack` - `PartialGuild::{search, search_channels}` - `PrivateChannel::{ack, search}` - `UserId::{delete_note, edit_note}` - `User::{delete_note, edit_note}` The following events in `model::events` have been removed: - `FriendSuggestionCreateEvent` - `FriendSuggestionDeleteEvent` - `MessageAckEvent` - `RelationshipAddEvent` - `RelationshipRemoveEvent` - `UserGuildSettingsUpdateEvent` - `UserNoteUpdateEvent` - `UserSettingsUpdateEvent` Consequently, the following variants on `model::event::Event` have been removed: - `FriendSuggestionCreate` - `FriendSuggestionDelete` - `MessageAdd` - `RelationshipAdd` - `RelationshipRemove` - `UserGuildSettingUpdate` - `UserNoteUpdate` - `UserSettingsUpdate` The `utils::builder::Search` search builder has been removed.
* Update search paramsZeyla Hellyer2017-03-252-201/+135
|
* Remove sending message noncesZeyla Hellyer2017-02-271-10/+0
|
* Add missing send_file/send_message implsZeyla Hellyer2017-02-251-3/+10
| | | | | | | | | | | | Add the `send_file` method to: - `model::Channel` - `model::Group` - `model::GuildChannel` Add the `send_message` method to: - `model::Channel` Additionally, add more documentation for these with an example.
* Update doctests for Context changesZeyla Hellyer2017-02-155-15/+14
| | | | | | | | | | | | | | | | | | | Due to the Context having many methods removed, the doctests were failing. Update the doctests to use alternative methods to accomplish the same. Example: Before: ```rust context.say("hi"); ``` After: ```rust message.channel_id.say("hi") ```
* Add method to EditGuild to transfer ownershipZeyla Hellyer2017-02-071-1/+8
| | | | | There used to be a method to do the equivilant but was lost in the move to an OOP pattern, so this should be re-added back.
* Remove lifetime on SearchZeyla Hellyer2017-02-071-4/+4
|
* Fix docs linksAustin Hellyer2017-01-247-17/+21
|
* Convert Colour to be a tuple structAustin Hellyer2017-01-132-2/+2
| | | | The struct only has one field (`value`) anyway.
* Fix rs suffixIllia2017-01-052-2/+2
|
* Implement context message queueingTaavi2017-01-011-6/+5
| | | Also the dreaded `ctx <<= "something"` which is actually a mistake.
* Fix doctestAustin Hellyer2016-12-311-12/+17
|
* Fix typoIllia2016-12-311-2/+2
|
* Add guild and channel searchAustin Hellyer2016-12-292-0/+381
|
* Remove image/thumbnail embed buildersAustin Hellyer2016-12-182-84/+13
| | | | | | | | When implemented, it was thought that images and thumbnails would be able to have their height/width specified. This isn't the case, and so the image/height methods were deprecated on the builders. Time has passed, so just remove them in favour of direct methods on CreateEmbed instead.
* Allow time::Tm to be passed into embed timestampAustin Hellyer2016-12-181-9/+44
|
* No Z or +XX:XXChristopher F2016-12-181-3/+4
| | | | Eventual Consistency:tm:
* Add documentation regarding ISO-8601 to embedsChristopher F2016-12-181-0/+7
|
* Implement command groups and bucketsIllia2016-12-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Implement command groups * change to ref mut * Implement framework API. * Remove commands field * Make it all work * Make example use command groups * Requested changes * Implement adding buckets * Add ratelimit check function * Finish everything * Fix voice example * Actually fix it * Fix doc tests * Switch to result * Savage examples * Fix docs * Fixes * Accidental push * 👀 * Fix an example * fix some example * Small cleanup * Abstract ratelimit bucket logic
* Fix no-cache+method conditional compilesAustin Hellyer2016-12-101-1/+1
| | | | Additionally, flag imports behind feature flags to avoid unused imports.
* Deprecate embed image/thumbnail height/widthAustin Hellyer2016-12-091-36/+10
| | | | | | The height and width fields for embed images and thumbnails can not be set - whereas originally there may have been plans to - so deprecate them and remove in v0.3.0.
* Implement From<Embed> for CreateEmbedAustin Hellyer2016-12-081-1/+70
|
* Add more Context docs+permission requirementsAustin Hellyer2016-12-041-1/+22
| | | | | Add more documentation to most of the Context methods, also clarifying which permission/s are required for each method.
* Add documentation for modelsIllia2016-12-041-3/+8
|
* Add documentation for EditMember and EditProfileKisei2016-11-302-0/+15
|
* Clean up the codebaseAustin Hellyer2016-11-292-37/+0
|
* Improve docs and add new message builder methodsIllia K2016-11-282-16/+4
| | | | | Add documentation for some missing methods - such as Game methods - and add more methods to the Message Builder.
* Re-export CreateEmbedFooterKisei2016-11-271-0/+1
|
* Add a bit more docsAustin Hellyer2016-11-262-5/+110
|
* Remove the 'extras' feature flagAustin Hellyer2016-11-261-10/+4
| | | | | | There aren't many things behind this flag (6), and it only causes annoyances for locally-generated docs, which won't show these mostly-useful items behind the flag.
* Rename PublicChannel to GuildChannelAustin Hellyer2016-11-251-4/+4
|
* Rename the `http` module to `rest`Austin Hellyer2016-11-252-5/+5
|
* Rename guild structs to Guild and PartialGuildAustin Hellyer2016-11-241-2/+2
|
* Ensure embed fields are inline by defaultAustin Hellyer2016-11-231-1/+1
| | | | | | | 90% of use cases require embed fields to be inlined, so it's a better default. Also this makes the documentation accurate.
* Don't typo CreateEmbed::image fieldAustin Hellyer2016-11-211-1/+1
|
* Add support for creating embed imagesAustin Hellyer2016-11-212-0/+49
|
* A bit of docsAustin Hellyer2016-11-184-2/+68
|
* Add send_message rich embedsAustin Hellyer2016-11-153-21/+340
|
* Add state/framework/etc. conditional compile flagsAustin Hellyer2016-11-151-4/+10
| | | | | | | | | | | | | | | This adds conditional compilation for the following features, in addition to the voice conditional compilation flag: - extras (message builder) - framework - methods - state These 4 are enabled _by default_, while the `voice` feature flag is disabled. Disabling the state will allow incredibly low-memory bots.
* Add a message builder for Context::send_messageAustin Hellyer2016-11-152-0/+73
| | | | | | | | | | | | | | | | Add a message builder to `send_message`. Often only one field - i.e. `content` - needs to be specified, and the rest can be ignored. This is a preliminary patch to add rich embed support to messages. This message builder is used via: ```rust // assuming in a context with a `channel_id` bound context.send_message(channel_id, |m| m .content("TTS ping!") .tts(true)); ```
* Decode embed/role colours into Colour structAustin Hellyer2016-11-141-1/+1
| | | | | | This is for a little bit of ergonomics, and is of such a minute cost that it is worth it to just directly decode the u32's received for Role/Embed colours into the Colour struct.
* Move the builders to the utilsAustin Hellyer2016-11-1310-0/+637
The builders aren't a large enough portion of the library to deserve their own root-level module, so move them to the `utils` module. Additionally, split them into separate files, as the library will be receiving more builders and the single-file pattern was getting rather large.
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-12 22:48:29 +0000