Struct RiPrivateProtocol 

pub struct RiPrivateProtocol { /* private fields */ }

Implementations

impl RiPrivateProtocol

pub fn new() -> Self

impl RiPrivateProtocol

pub fn is_ready_sync(&self) -> bool

pub fn initialize(&mut self, config: RiProtocolConfig) -> bool

pub fn get_stats(&self) -> RiProtocolStats

pub fn get_health(&self) -> RiProtocolHealth

pub fn shutdown(&mut self) -> bool

Trait Implementations

impl Clone for RiPrivateProtocol

fn clone(&self) -> RiPrivateProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiPrivateProtocol

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

Formats the value using the given formatter.

impl Default for RiPrivateProtocol

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiPrivateProtocol

type Target = RiPrivateProtocol

The Python output type

type Output = Bound<'py, <RiPrivateProtocol 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<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiPrivateProtocol

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiPrivateProtocol

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 = c"\x00"

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiPrivateProtocol>

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyMethods<RiPrivateProtocol> for PyClassImplCollector<RiPrivateProtocol>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiPrivateProtocol

const NAME: &'static str = "RiPrivateProtocol"

Class name.

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

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 RiProtocol for RiPrivateProtocol

fn protocol_type(&self) -> RiProtocolType

Get protocol type

fn is_ready<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if protocol is ready

fn initialize<'life0, 'async_trait>( &'life0 mut self, config: RiProtocolConfig, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initialize protocol

fn send_message<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, target: &'life1 str, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = RiResult<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Send message

fn send_message_with_flags<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, target: &'life1 str, data: &'life2 [u8], flags: RiMessageFlags, ) -> Pin<Box<dyn Future<Output = RiResult<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Send message with flags

fn receive_message<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = RiResult<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receive message

fn get_connection_info<'life0, 'life1, 'async_trait>( &'life0 self, connection_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = RiResult<RiConnectionInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get connection info

fn close_connection<'life0, 'life1, 'async_trait>( &'life0 mut self, connection_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Close connection

fn get_stats(&self) -> RiProtocolStats

Get protocol statistics

fn get_health<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = RiProtocolHealth> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get protocol health

fn shutdown<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Shutdown protocol

impl DerefToPyAny for RiPrivateProtocol

impl ExtractPyClassWithClone for RiPrivateProtocol