Struct shell_protocol::ShellProtocol

source · [−]

pub struct ShellProtocol { /* private fields */ }

Expand description

Shell Service Protocol structure

This structure is only intended for usage inside of the shell service. It is not required for usage by shell clients.

Implementations

source

impl Protocol

source

pub fn new(
 channel_protocol: ChannelProtocol,
 channel_id: u32,
 process: Box<ProcessHandler>
) -> Self

Create new instance of shell protocol structure

Arguments

channel_protocol - Instance of ChannelProtocol
channel_id - Channel ID of shell session
process - Instance of ProcessHandler

source

pub fn message_engine<F>(
 &mut self,
 pump: F,
 timeout: Duration
) -> Result<(), ProtocolError> where
 F: Fn(Duration) -> Result<(ChannelMessage, SocketAddr), ProtocolError>,

Listen for and process shell protocol messages

Arguments

pump - Function which returns the next message for processing
timeout - Maximum time to listen for a single message

Errors

If this function encounters any errors, it will return an error message string

Auto Trait Implementations

impl !RefUnwindSafe for Protocol

impl Send for Protocol

impl !Sync for Protocol

impl Unpin for Protocol

impl UnwindSafe for Protocol

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct shell_protocol::ShellProtocol

Implementations

impl Protocol

pub fn new(
    channel_protocol: ChannelProtocol,
    channel_id: u32,
    process: Box<ProcessHandler>
) -> Self

Arguments

pub fn message_engine<F>(
    &mut self,
    pump: F,
    timeout: Duration
) -> Result<(), ProtocolError> where
    F: Fn(Duration) -> Result<(ChannelMessage, SocketAddr), ProtocolError>,

Arguments

Errors

Auto Trait Implementations

impl !RefUnwindSafe for Protocol

impl Send for Protocol

impl !Sync for Protocol

impl Unpin for Protocol

impl UnwindSafe for Protocol

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct shell_protocol::ShellProtocol

Implementations

impl Protocol

pub fn new( channel_protocol: ChannelProtocol, channel_id: u32, process: Box<ProcessHandler>) -> Self

pub fn message_engine<F>( &mut self, pump: F, timeout: Duration) -> Result<(), ProtocolError> where F: Fn(Duration) -> Result<(ChannelMessage, SocketAddr), ProtocolError>,

Auto Trait Implementations

impl !RefUnwindSafe for Protocol

impl Send for Protocol

impl !Sync for Protocol

impl Unpin for Protocol

impl UnwindSafe for Protocol

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn new(
channel_protocol: ChannelProtocol,
channel_id: u32,
process: Box<ProcessHandler>
) -> Self

pub fn message_engine<F>(
&mut self,
pump: F,
timeout: Duration
) -> Result<(), ProtocolError> where
F: Fn(Duration) -> Result<(ChannelMessage, SocketAddr), ProtocolError>,

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

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

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

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

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

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