Trait NetSession

pub trait NetSession: NetStream + SplitIo {
    type Inner: NetSession;
    type Connection: NetConnection;
    type Artifact: Display;

    // Required methods
    fn run_handshake(&mut self) -> Result<()>;
    fn artifact(&self) -> Option<Self::Artifact>;
    fn as_connection(&self) -> &Self::Connection;
    fn as_connection_mut(&mut self) -> &mut Self::Connection;
    fn disconnect(self) -> Result<()>;

    // Provided methods
    fn is_established(&self) -> bool { ... }
    fn display(&self) -> String { ... }
}

Required Associated Types

type Inner: NetSession

Inner session type

type Connection: NetConnection

Underlying connection

type Artifact: Display

Required Methods

fn run_handshake(&mut self) -> Result<()>

fn artifact(&self) -> Option<Self::Artifact>

fn as_connection(&self) -> &Self::Connection

fn as_connection_mut(&mut self) -> &mut Self::Connection

fn disconnect(self) -> Result<()>

Provided Methods

fn is_established(&self) -> bool

fn display(&self) -> String

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl NetSession for TcpStream

type Inner = TcpStream

type Connection = TcpStream

type Artifact = SocketAddr

fn run_handshake(&mut self) -> Result<()>

fn artifact(&self) -> Option<Self::Artifact>

fn as_connection(&self) -> &Self::Connection

fn as_connection_mut(&mut self) -> &mut Self::Connection

fn disconnect(self) -> Result<()>

impl NetSession for Socket

Available on crate feature socket2 only.

type Inner = Socket

type Connection = Socket

type Artifact = SocketAddr

fn run_handshake(&mut self) -> Result<()>

fn artifact(&self) -> Option<Self::Artifact>

fn as_connection(&self) -> &Self::Connection

fn as_connection_mut(&mut self) -> &mut Self::Connection

fn disconnect(self) -> Result<()>

Implementors

impl<M: NetStateMachine, S: NetSession> NetSession for NetProtocol<M, S>

where S::Artifact: IntoInit<M::Init>,

type Inner = S

type Connection = <S as NetSession>::Connection

type Artifact = ProtocolArtifact<M, S>