[][src]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. SpecifierStack - specifier class, final string argument and vector of overlays.
  3. Specifier - more rigid version of SpecifierStack, with everything parsable parsed. May be nested. When construct is called, we get:
  4. PeerConstructor - a future or stream that returns one or more connections. After completion, we get one or more of:
  5. Peer - an active connection. Once we have two of them, we can start a:
  6. Session with two Transfers - forward and reverse.

Re-exports

pub use options::Options;
pub use specifier::ClassMessageBoundaryStatus;
pub use specifier::ClassMulticonnectStatus;
pub use specifier::ConstructParams;
pub use specifier::Specifier;
pub use specifier::SpecifierClass;
pub use specifier::SpecifierStack;
pub use util::brokenpipe;
pub use util::io_other_error;
pub use util::simple_err2;
pub use util::wouldblock;
pub use util::box_up_err;
pub use util::multi;
pub use util::once;
pub use util::peer_err;
pub use util::peer_err_s;
pub use util::peer_strerr;
pub use util::simple_err;
pub use specparse::spec;
pub use sessionserve::serve;

Modules

all_peers
broadcast_reuse_peer
file_peer
jsonrpc_peer
line_peer
lints
mirror_peer
net_peer
options
primitive_reuse_peer
process_peer
proxy_peer
readdebt
reconnect_peer
sessionserve
specifier
specparse
stdio_threaded_peer
trivial_peer
util
ws_client_peer
ws_peer
ws_server_peer

Macros

list_of_all_specifier_classes

Structs

LeftSpecToRightSpec

Some information passed from the left specifier Peer to the right

Peer
ProgramState
Session
Transfer
WebsocatConfiguration1
WebsocatConfiguration2
WebsocatConfiguration3

Enums

L2rUser
PeerConstructor

Functions

spawn_hack

A remnant of the hack

Type Definitions

BoxedNewPeerFuture
BoxedNewPeerStream
L2rWriter
L2rReader
PeerOverlay