Struct twilight_lavalink::node::NodeConfig

#[non_exhaustive]pub struct NodeConfig {
    pub address: SocketAddr,
    pub authorization: String,
    pub resume: Option<Resume>,
    pub shard_count: u64,
    pub user_id: UserId,
}

The configuration that a Node uses to connect to a Lavalink server.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: SocketAddr

The address of the node.

authorization: String

The password to use when authenticating.

resume: Option<Resume>

The details for resuming a Lavalink session, if any.

Set this to None to disable resume capability.

shard_count: u64

The number of shards in use by the bot.

user_id: UserId

The user ID of the bot.

Implementations

impl NodeConfig

pub fn new(
    user_id: UserId,
    shard_count: u64,
    address: impl Into<SocketAddr>,
    authorization: impl Into<String>,
    resume: impl Into<Option<Resume>>
) -> Self

Create a new configuration for connecting to a node via Node::connect.

If adding a node through the Lavalink client then you don't need to do this yourself.

Trait Implementations

impl Clone for NodeConfig

pub fn clone(&self) -> NodeConfig

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NodeConfig

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for NodeConfig

impl PartialEq<NodeConfig> for NodeConfig

pub fn eq(&self, other: &NodeConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &NodeConfig) -> bool

This method tests for !=.

impl StructuralEq for NodeConfig

impl StructuralPartialEq for NodeConfig