New features:
- Added
#[min_length]
and#[max_length]
support for slash command string parameters
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.5.4...v0.5.5
API updates:
- The
payload
field ofFrameworkError::CommandPanic
has been changed fromBox<dyn Any + Send>
toOption<String>
- This is technically a breaking change
- However, the newly introduced
payload
field in 0.5.3 madeFrameworkError
accidentally not Sync anymore - And
FrameworkError::CommandPanic
has only been introduced a few days ago in 0.5.3 - Therefore, I think it's ok to release this as a patch release to reverse the accidental breaking change from 0.5.3
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.5.3...v0.5.4
New features:
- Added
builtins::paginate()
as an example implementation of pagination - Added missing events in
EventWrapper
(#144) - Added
FrameworkError::CommandPanic
to allow custom handling of panics (#140)builtins::on_error
responds with an "Internal error" embed when encounteringCommandPanic
Behavior changes:
builtins::on_error
now printsFrameworkError::Command
not just in Discord chat, but in console as well- because responding in Discord sometimes doesn't work, see 0a03fb905ca0bc3b2ee0701fe35d3c89ecf5a654
- Fixed a compile error when
name_localized
ordescription_localized
are used multiple times (#143)
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.5.2...v0.5.3
New features:
- Added
track_deletion
feature to commands - Added all of
Context
's methods toPrefixContext
andApplicationContext
Behavior changes:
- Editing commands not marked track_edits no longer re-runs the command
builtins::servers
now shows hidden statistics for the entire bot team, not just owner
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.5.1...v0.5.2
New features:
- Added
FrameworkOptions::skip_checks_for_owner
Behavior changes:
execute_modal
doesn't panic anymore when the timeout is reached- Checking user permissions properly falls back to HTTP when cache is enabled but empty
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.5.0...v0.5.1
New features:
- Added
Context::parent_commands()
- Added
Context::invocation_string()
- Added
builtins::register_in_guild()
andbuiltins::register_globally()
convenience functions - The return value of autocomplete callbacks can be any serializable type now
Context
can now be passed directly into most serenity API functions- Because it now implements
AsRef<Cache>
,AsRef<Http>
,AsRef<ShardMessenger>
, andCacheHttp
traits
- Because it now implements
- Added
execute_modal()
function with support for modal timeouts
API updates:
Modal::create()
gained acustom_id: String
parameter- To make it possible to tell apart two modal interactions
- Removed
CreateReply::reference_message(MessageReference)
in favor ofCreateReply::reply(bool)
- For the unusual case of setting a different reference message than the invocation (why would you? I'm genuinely interested), you can still convert the
CreateReply
intoserenity::CreateMessage
manually via.to_prefix()
and callserenity::CreateMessage
'sreference_message()
method
- For the unusual case of setting a different reference message than the invocation (why would you? I'm genuinely interested), you can still convert the
- Renamed
FrameworkBuilder::user_data_setup()
method tosetup()
- Renamed
FrameworkOptions::listener
field toevent_handler
- Renamed
Context::discord()
method toserenity_context()
Behavior changes:
register_application_commands_buttons()
now has emojis, reworked wording, and prints the time taken to registerModal::execute()
always responds to the correct modal now- When a subcommand is invoked, all parent commands' checks are run too, now
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.4.1...v0.5.0
Behavior changes:
- Slash commands marked guild_only don't show up in DMs anymore
- Using Discord's dm_permission field on commands
poise::builtins::servers
now doesn't omit unavailable guilds from guild count and list anymore
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.4.0...v0.4.1
New features:
- Added std::error::Error impl for FrameworkError
- Added
FrameworkError::discord() -> &serenity::Context
method - Added
FrameworkError::ctx() -> Option<poise::Context>
method - Added
FrameworkError::handle()
method which calls the appropriate on_error function on itself - Added Copy and Clone impl for PartialContext
- Added
ReplyHandle::delete()
- Added
FrameworkError::UnknownCommand
andFrameworkError::UnknownInteraction
- These error cases would previously just
log::warn!()
- These error cases would previously just
- Exposed internals of
dispatch_message()
as new functionsparse_invocation()
andrun_invocation()
- Added trigger and action callback to PrefixContext
- Made EditTracker methods public:
process_message_update()
,set_bot_response()
,track_command()
API updates:
- Added or changed fields of some FrameworkError enum variants
- Removed
cmd: &Command
parameter from check_permissions_and_cooldown (Context already includes it) - triggered_by_edit and previously_tracked bool parameters replaced by new MessageDispatchTrigger enum
- Simplified return type of
dispatch_message()
,dispatch_interaction()
, anddispatch_autocomplete()
toResult<(), FrameworkError>
- Simplified return type of
extract_command_and_run_checks()
toResult<ApplicationContext, FrameworkError>
- Removed
futures_core
re-export
Behavior changes:
- Internal warnings now use
log::warn!()
/log::error!()
instead ofeprintln!()
- That way, you can mute them or handle them specially
- Default
FrameworkError::DynamicPrefix
handler now prints message content ReplyHandle::edit()
now replaces existing attachments and embeds instead of adding on top- Cooldowns are now triggered before command execution instead of after
- Added
log::warn!()
in some weird code paths that shouldn't be hit - When a focused autocomplete option has an unrecognized name and when the autocomplete value is not a string,
FrameworkError::CommandStructureMismatch
is now thrown- Instead of discarding the error
register_application_commands_buttons()
switched order of rows- Guild-specific actions are at the top because they are more common and less destructive
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.3.0...v0.4.0
New features:
- Custom arbitrary data associated with commands via custom_data command attribute and Command struct field
- Make it easier to run a custom event loop by exposing important setup functions
set_qualified_names()
insert_owners_from_http()
- This code is run under the hood in the framework setup code and is now accessible to custom event loops too
- The time crate can now be used in place of chrono (#83)
- You can now use the
check
command attribute multiple times to add multiple checks - Support for Discord's localization API (#82)
Framework::client()
method to get the underlyingserenity::Client
API updates:
Framework::shard_manager()
now returns&Arc
instead ofArc
Context::author_member()
return type changed fromMember
toCow<'_, Member>
to avoid needless cloning (#81)- Use
.into_owned()
to convertCow<'_, Member>
back toMember
- Use
fn message(self) -> Message
method on ReplyHandle split intofn message(&self) -> Cow<'_, Message>
andfn into_message(self) -> Message
(#84)- Reduces cloning if you just need a reference to the message
- Allows using the ReplyHandle after retrieving the message
Framework::build()
renamed toFramework::builder()
(#96)Framework::start_with()
now takesimpl FnOnce
instead offn
- To be usable with with
serenity::Client
'sstart_shard
,start_shard_range
, andstart_shards
methods
- To be usable with with
- Removed
serenity
re-export at crate root (serenity_prelude
still exists!) - Command fields renamed:
inline_help
=>description
,multiline_help
=>help_text
- Command and parameter
name
anddescription
fields changed from&'static str
toString
- To make them overrideable at runtime
- Autocomplete functions' partial input parameter is now always
&str
- Was previously String, [i/u][8/16/32/64], f[32/64], depending on parameter type
Behavior changes:
- Fix identifying_name command attribute not being applied
- Built-in register commands now report command count correctly
- Prefix-only commands aren't included anymore
ReplyHandle::edit()
now keeps parts of the message as before if not specified- Fix number autocomplete (was completely borked)
- Code block parsing is now more precise
- With ```textwithspecialcharacters, textwithspecialcharacters is no longer recognized as the programming language, but as part of the code (mirroring Discord's behavior)
ReplyHandle::edit()
now works on ephemeral followup responses
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.2.2...v0.3.0
Behavior changes:
default_member_permissions
fixed to not constrain commands to administrators by default
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.2.1...v0.2.2
Behavior changes:
- Bot ID is retrieved from first Ready event again instead of extracted from the token. Extracting the bot ID from the bot token often didn't work and caused breakage for many users. This should now be fixed
https://github.com/kangalioo/poise/compare/v0.2.0...v0.2.1
New features:
PrefixFrameworkOptions::ignore_bots
to disable executing commands posted by botsbuiltins::register_application_commands_buttons()
allows managing slash command registration with buttons#[poise(subcommands(...))]
attribute argument as a convenient alternative to manually setting theCommand::subcommands
fielddispatch_event()
function to allow running your own event loop without involving Framework at allModal::create()
andModal::execute_with_defaults()
can be used to spawn a modal with pre-filled valuesdefault_member_permissions
command attribute argument, part of Discord Permissions V2Context::partial_guild
to easily get guild information without cache enabled
API updates:
- Poise no longer depends on serenity's cache feature
- Some structs and enums were made non-exhaustive to make future non-breaking changes easier
- The
Event
enum has been updated to include allserenity::EventHandler
events again FrameworkBuilder::initialize_owners()
takes self instead of &mut self, like the other builder methods- The macro generated code emits
::std::result::Result
instead ofResult
now, which prevents collisions with user-defined Result type aliases CreateReply
now implementsClone
- Some callbacks were changed to receive
FrameworkContext<'_, U, E>
instead of&Framework<U, E>
(had to be done fordispatch_event()
)
Behavior changes:
- Autocomplete callbacks and argument parse errors don't cause a cooldown trigger anymore
- Features using the bot's ID now work again (execute_self_messages, required_bot_permissions, mention_as_prefix)
- Guild owners can no longer register slash commands in their guild (only bot owners now)
- Compile times should be faster through less monomorphization bloat
- Attachments in initial responses are supported now
Detailed changelog: https://github.com/kangalioo/poise/compare/v0.1.0...v0.2.0
Initial crates.io release