Struct IoManager

Source
pub struct IoManager<SendType, ReceiveType = SendType> { /* private fields */ }
Expand description

A simplified interface to interact with tokio’s streams and sinks.

Allows easy subscription to the stream’s frames, and easy sending to the sink.

Implementations§

Source§

impl<SendType, ReceiveType> IoManager<SendType, ReceiveType>

Source

pub fn subscribe_mpsc_sender(&self, subscriber: Sender<ReceiveType>) -> u32

subscriber will receive any data polled from the internal stream.

Source

pub fn on_receive<F>(&self, callback: F) -> u32
where F: FnMut(ReceiveType) -> Result<(), ()> + Send + 'static, ReceiveType: Send + 'static,

callback will be called for each frame polled from the internal stream.

Examples found in repository?
examples/tcp_server.rs (lines 67-71)
51fn process_socket(socket: TcpStream) {
52    println!("New Client");
53    let (sink, stream) = LineCodec.framed(socket).split();
54    let trx = IoManagerBuilder::new(sink, stream)
55        .with_filter(|frame, writer| {
56            if frame.to_lowercase().contains("hello there") {
57                writer.write("General Kenobi!".to_string());
58                return None;
59            }
60            Some(frame)
61        })
62        .with_error_handler(move |error| {
63            println!("{}", error);
64        })
65        .build();
66    let mut writer = trx.get_writer();
67    trx.on_receive(move |frame| {
68        println!("Got frame: {}", frame);
69        writer.write("Hi there".to_string());
70        Ok(())
71    });
72}
Source

pub fn extract_callback(&self, key: &u32) -> Option<Sender<ReceiveType>>

Removes the callback with keyhandle. key should be a value returned by either on_receive() or subscribe_mpsc_sender().

Returns the mpsc::Sender that used to be notified upon new frames, just in case.

Source

pub fn get_writer(&self) -> IoWriter<SendType>

Returns an IoWriter that will forward data to the associated tokio sink.

Examples found in repository?
examples/tcp_server.rs (line 66)
51fn process_socket(socket: TcpStream) {
52    println!("New Client");
53    let (sink, stream) = LineCodec.framed(socket).split();
54    let trx = IoManagerBuilder::new(sink, stream)
55        .with_filter(|frame, writer| {
56            if frame.to_lowercase().contains("hello there") {
57                writer.write("General Kenobi!".to_string());
58                return None;
59            }
60            Some(frame)
61        })
62        .with_error_handler(move |error| {
63            println!("{}", error);
64        })
65        .build();
66    let mut writer = trx.get_writer();
67    trx.on_receive(move |frame| {
68        println!("Got frame: {}", frame);
69        writer.write("Hi there".to_string());
70        Ok(())
71    });
72}

Trait Implementations§

Source§

impl<SendType: Clone, ReceiveType: Clone> Clone for IoManager<SendType, ReceiveType>

Source§

fn clone(&self) -> IoManager<SendType, ReceiveType>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<SendType, ReceiveType> Freeze for IoManager<SendType, ReceiveType>

§

impl<SendType, ReceiveType = SendType> !RefUnwindSafe for IoManager<SendType, ReceiveType>

§

impl<SendType, ReceiveType> Send for IoManager<SendType, ReceiveType>
where SendType: Send, ReceiveType: Send,

§

impl<SendType, ReceiveType> Sync for IoManager<SendType, ReceiveType>
where SendType: Send, ReceiveType: Send,

§

impl<SendType, ReceiveType> Unpin for IoManager<SendType, ReceiveType>

§

impl<SendType, ReceiveType = SendType> !UnwindSafe for IoManager<SendType, ReceiveType>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Erased for T