Struct SocketConnection

pub struct SocketConnection<StateType: Debug> { /* private fields */ }

A wrapper for a TcpStream – attaching a custom “state” and unique id to it.
This abstraction plays a role in enabling the “Composite Protocol Stacking” design pattern.
IMPLEMENTATION NOTE: The crate::prelude::Peer object still holds a copy of the state – synced elsewhere with us here – in the future, this should be reworked.

Implementations

impl<StateType: Debug> SocketConnection<StateType>

pub fn new(connection: TcpStream, initial_state: StateType) -> Self

pub fn connection(&self) -> &TcpStream

pub fn connection_mut(&mut self) -> &mut TcpStream

pub fn id(&self) -> ConnectionId

pub fn state(&self) -> &StateType

pub fn set_state(&mut self, new_state: StateType)

pub fn closed(&self) -> bool

pub fn report_closed(&mut self)

Trait Implementations

impl<StateType: Debug + Debug> Debug for SocketConnection<StateType>

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

Formats the value using the given formatter.