Struct NodeConfig

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

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.

user_id: Id<UserMarker>

The user ID of the bot.

Implementations

impl NodeConfig

pub fn new( user_id: Id<UserMarker>, 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

fn clone(&self) -> NodeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl PartialEq for NodeConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NodeConfig

impl StructuralPartialEq for NodeConfig