pub struct ClientBuilder { /* private fields */ }
Available on crate features client and gateway only.
Expand description

A builder implementing Future building a Client to interact with Discord.

Implementations

Construct a new builder to call methods on for the client construction. The token will automatically be prefixed “Bot “ if not already.

Panic: If you have enabled the framework-feature (on by default), you must specify a framework via the Self::framework or Self::framework_arc method, otherwise awaiting the builder will cause a panic.

Construct a new builder with a Http instance to calls methods on for the client construction.

Panic: If you have enabled the framework-feature (on by default), you must specify a framework via the Self::framework or Self::framework_arc method, otherwise awaiting the builder will cause a panic.

Sets a token for the bot. If the token is not prefixed “Bot “, this method will automatically do so.

Gets the current token used for the Http client. This can be unwrapped safely unless used after awaiting the builder.

Sets the application id.

Gets the application ID, if already initialized. See Self::application_id for more info.

Sets the entire TypeMap that will be available in Contexts. A TypeMap must not be constructed manually: Self::type_map_insert can be used to insert one type at a time.

Gets the type map. See Self::type_map for more info. This can be unwrapped safely unless used after awaiting the builder.

Insert a single value into the internal TypeMap that will be available in Context::data. This method can be called multiple times in order to populate the TypeMap with values.

Available on crate feature cache only.

Sets the settings of the cache. Refer to Settings for more information.

Available on crate feature cache only.

Gets the cache settings. See Self::cache_settings for more info. This can be unwrapped safely unless used after awaiting the builder.

Available on crate feature framework only.

Sets the command framework to be used. It will receive messages sent over the gateway and then consider - based on its settings - whether to dispatch a command.

Info: If a reference to the framework is required for manual dispatch, use the Self::framework_arc-method instead.

Available on crate feature framework only.

This method allows to pass an Arc’ed framework - this step is done for you in the Self::framework-method, if you don’t need the extra control. You can provide a clone and keep the original to manually dispatch.

Available on crate feature framework only.

Gets the framework, if already initialized. See Self::framework for more info.

Available on crate feature voice only.

Sets the voice gateway handler to be used. It will receive voice events sent over the gateway and then consider - based on its settings - whether to dispatch a command.

Info: If a reference to the voice_manager is required for manual dispatch, use the Self::voice_manager_arc-method instead.

Available on crate feature voice only.

This method allows to pass an Arc’ed voice_manager - this step is done for you in the voice_manager-method, if you don’t need the extra control. You can provide a clone and keep the original to manually dispatch.

Available on crate feature voice only.

Gets the voice manager, if already initialized. See Self::voice_manager for more info.

Sets all intents directly, replacing already set intents. Intents are a bitflag, you can combine them by performing the |-operator.

What are Intents

A gateway intent sets the types of gateway events (e.g. member joins, guild integrations, guild emoji updates, …) the bot shall receive. Carefully picking the needed intents greatly helps the bot to scale, as less intents will result in less events to be received hence less processed by the bot.

Privileged Intents

The intents GatewayIntents::GUILD_PRESENCES, GatewayIntents::GUILD_MEMBERS and GatewayIntents::MESSAGE_CONTENT are privileged. Privileged intents need to be enabled in the developer portal. Once the bot is in 100 guilds or more, the bot must be verified in order to use privileged intents.

Gets the intents. See Self::intents for more info.

Sets an event handler with multiple methods for each possible event.

Sets an event handler with multiple methods for each possible event. Passed by Arc.

Gets the event handler, if already initialized. See Self::event_handler for more info.

Sets an event handler with a single method where all received gateway events will be dispatched.

Gets the raw event handler, if already initialized. See Self::raw_event_handler for more info.

Trait Implementations

The type of value produced on completion.

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Map this future’s output to a different type, returning a new future of the resulting type. Read more

Map this future’s output to a different type, returning a new future of the resulting type. Read more

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

Convert this future into a single element stream. Read more

Flatten the execution of this future when the output of this future is itself another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

Do something with the output of a future before passing it on. Read more

Available on crate feature std only.

Catches unwinding panics while polling the future. Read more

Available on crate feature std only.

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

Available on crate features channel and std only.

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

Available on crate feature alloc only.

Wrap the future in a Box, pinning it. Read more

Available on crate feature alloc only.

Wrap the future in a Box, pinning it. Read more

A convenience for calling Future::poll on Unpin future types.

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type of successful values yielded by this future

The type of failures yielded by this future

Poll this TryFuture as if it were a Future. Read more

Available on crate feature sink only.

Flattens the execution of this future when the successful result of this future is a [Sink]. Read more

Maps this future’s success value to a different value. Read more

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

Maps this future’s error value to a different value. Read more

Maps this future’s Error to a new error type using the Into trait. Read more

Maps this future’s Ok to a new type using the Into trait. Read more

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

Do something with the success value of a future before passing it on. Read more

Do something with the error value of a future before passing it on. Read more

Flatten the execution of this future when the successful result of this future is another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

Wraps a [TryFuture] into a type that implements Future. Read more

A convenience method for calling [TryFuture::try_poll] on Unpin future types. Read more

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more