Struct twilight_lavalink::node::NodeConfig[][src]

#[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[src]

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

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[src]

impl Debug for NodeConfig[src]

impl Eq for NodeConfig[src]

impl PartialEq<NodeConfig> for NodeConfig[src]

impl StructuralEq for NodeConfig[src]

impl StructuralPartialEq for NodeConfig[src]

Auto Trait Implementations

impl RefUnwindSafe for NodeConfig

impl Send for NodeConfig

impl Sync for NodeConfig

impl Unpin for NodeConfig

impl UnwindSafe for NodeConfig

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,