Struct serenity::client::ClientBuilder [−][src]
pub struct ClientBuilder<'a> { /* fields omitted */ }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.
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, if already initialized. See Self::type_map for more info.
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.
Sets how long - if wanted to begin with - a cache update shall
be attempted for. After the timeout ran out, the update will be
skipped.
By default, a cache update will never timeout and potentially cause a deadlock. A timeout however, will invalidate the cache.
Gets the cache update timeout, if already initialized. See Self::cache_update_timeout
for more info.
pub fn cache_settings<F>(self, f: F) -> Self where
F: FnOnce(&mut CacheSettings) -> &mut CacheSettings,
pub fn cache_settings<F>(self, f: F) -> Self where
F: FnOnce(&mut CacheSettings) -> &mut CacheSettings,
Sets the settings of the cache.
Refer to Settings for more information.
Gets the cache settings. See Self::cache_settings 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 and GatewayIntents::GUILD_MEMBERS
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.
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
Auto Trait Implementations
impl<'a> !RefUnwindSafe for ClientBuilder<'a>
impl<'a> Send for ClientBuilder<'a>
impl<'a> !Sync for ClientBuilder<'a>
impl<'a> Unpin for ClientBuilder<'a>
impl<'a> !UnwindSafe for ClientBuilder<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
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
Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
Turn this future into a future that yields () on completion and sends
its output to another future on a separate task. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
Turns a Future<Output = T> into a
TryFuture<Ok = T, Error = ()>. Read more
Turns a Future<Output = T> into a
TryFuture<Ok = T, Error = Never>. 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 provided Span, returning an
Instrumented wrapper. Read more
into_future)The output that the future will produce on completion.
type Future = F
type Future = F
into_future)Which kind of future are we turning this into?
into_future)Creates a future from a value.
fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
Maps this future’s success value to a different value. Read more
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
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
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
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is another future. Read more
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
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