Enum TransportBackend 

pub enum TransportBackend {
    Tungstenite,
    Sockudo,
}

WebSocket transport backend selection.

Selection is runtime so multiple backends can compile side-by-side without a compile_error! collision under --all-features.

Sockudo is the default backend and is enabled by the transport-sockudo Cargo feature (on by default); it uses a local HTTP/1.1 handshake path to pass custom upgrade headers through. When the feature is disabled the default falls back to Tungstenite, which is always compiled and supports custom HTTP upgrade headers on the WebSocket handshake (see WebSocketConfig::headers).

Variants

Tungstenite

tokio-tungstenite backed transport (default when transport-sockudo is disabled).

Sockudo

sockudo-ws backed transport (default; gated on transport-sockudo feature).

Trait Implementations

impl Clone for TransportBackend

fn clone(&self) -> TransportBackend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TransportBackend

impl Debug for TransportBackend

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

Formats the value using the given formatter.

impl Default for TransportBackend

fn default() -> TransportBackend

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransportBackend

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TransportBackend

impl<'a, 'py> FromPyObject<'a, 'py> for TransportBackend

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl Hash for TransportBackend

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for TransportBackend

type Target = TransportBackend

The Python output type

type Output = Bound<'py, <TransportBackend as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'py>>::Output, <Self as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PartialEq for TransportBackend

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for TransportBackend

const NAME: &str = "TransportBackend"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for TransportBackend

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// WebSocket transport backend selection. /// /// Selection is runtime so multiple backends can compile side-by-side without /// a `compile_error!` collision under `--all-features`. /// /// `Sockudo` is the default backend and is enabled by the `transport-sockudo` /// Cargo feature (on by default); it uses a local HTTP/1.1 handshake path to /// pass custom upgrade headers through. When the feature is disabled the /// default falls back to `Tungstenite`, which is always compiled and supports /// custom HTTP upgrade headers on the WebSocket handshake (see /// [`WebSocketConfig::headers`]).

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<TransportBackend as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<TransportBackend>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForTransportBackend

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for TransportBackend

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for TransportBackend

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl Serialize for TransportBackend

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TransportBackend