Struct NodeBuilder

pub struct NodeBuilder {
    pub hostname: String,
    pub is_ssl: bool,
    pub events: Events,
    pub password: String,
    pub user_id: UserId,
    pub session_id: Option<String>,
}

A builder for the node.

Example

let node_builder = NodeBuilder {
    hostname: "localhost:2333".to_string(),
    password: "youshallnotpass".to_string(),
    user_id: UserId(551759974905151548),
    ..Default::default()
};

Fields

hostname: String

The hostname of the Lavalink server.

Example: “localhost:2333”

is_ssl: bool

If the Lavalink server is behind SSL encryption.

events: Events

The event handler specific for this node.

In most cases, the default is good.

password: String

The Lavalink server password.

user_id: UserId

The bot User ID that will use Lavalink.

session_id: Option<String>

The previous Session ID if resuming.

Trait Implementations

impl Clone for NodeBuilder

fn clone(&self) -> NodeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeBuilder

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for NodeBuilder

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for NodeBuilder

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for NodeBuilder

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<NodeBuilder>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<NodeBuilder> for PyClassImplCollector<NodeBuilder>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a NodeBuilder

type Holder = Option<PyRef<'py, NodeBuilder>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut NodeBuilder

type Holder = Option<PyRefMut<'py, NodeBuilder>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<NodeBuilder> for PyClassImplCollector<NodeBuilder>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for NodeBuilder

const NAME: &'static str = "NodeBuilder"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<NodeBuilder>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.