Struct SocketConfig

pub struct SocketConfig {
    pub url: String,
    pub mode: Mode,
    pub suffix: Vec<u8>,
    pub handler: Arc<PyObject>,
    pub heartbeat: Option<(u64, Vec<u8>)>,
}

Configuration for TCP socket connection.

Fields

url: String

The URL to connect to.

mode: Mode

The connection mode {Plain, TLS}.

suffix: Vec<u8>

The sequence of bytes which separates lines.

handler: Arc<PyObject>

The Python function to handle incoming messages.

heartbeat: Option<(u64, Vec<u8>)>

The optional heartbeat with period and beat message.

Trait Implementations

impl Clone for SocketConfig

fn clone(&self) -> SocketConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketConfig

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for SocketConfig

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

Performs the conversion.

impl PyClass for SocketConfig

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for SocketConfig

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<SocketConfig>

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<SocketConfig> for PyClassImplCollector<SocketConfig>

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

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

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

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

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

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

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

impl PyMethods<SocketConfig> for PyClassImplCollector<SocketConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for SocketConfig

const NAME: &'static str = "SocketConfig"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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

Returns the PyTypeObject instance for this type.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

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

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for SocketConfig