Crate websocat

Note: library usage is not semver/API-stable

Type evolution of a websocat run:

1. &str - string as passed to command line. When it meets the list of SpecifierClasses, there appears:
2. Specifier - more organized representation, may be nested. When construct is called, we get:
3. PeerConstructor - a future or stream that returns one or more connections. After completion, we get one or more of:
4. Peer - an active connection. Once we have two of them, we can start a:
5. Session with two Transfers - forward and reverse.

Re-exports

pub use specparse::spec;

Modules

all_peers
broadcast_reuse_peer
file_peer
line_peer
lints
mirror_peer
net_peer
primitive_reuse_peer
process_peer
reconnect_peer
specparse
stdio_threaded_peer
trivial_peer
ws_client_peer
ws_peer
ws_server_peer

Macros

list_of_all_specifier_classes

Structs

ConstructParams
LeftSpecToRightSpec	Some information passed from the left specifier Peer to the right
OneSpecifierInfo
Options
Peer
ProgramState
ReadDebt	A Read utility to deal with partial reads
Session
SpecifierInfo
Transfer
WebsocatConfiguration

Enums

PeerConstructor
SpecifierType	For checking specifier combinations for problems

Traits

Specifier	A parsed command line argument. For example, ws-listen:tcp-l:127.0.0.1:8080 gets parsed into a WsUpgrade(TcpListen(SocketAddr)).
SpecifierClass	A trait for a each specified type's accompanying object

Functions

box_up_err
multi
once
peer_err
peer_err_s
peer_from_str
peer_strerr
serve
simple_err

Type Definitions

BoxedNewPeerFuture
BoxedNewPeerStream
PeerOverlay