Crate websocat [] [src]

Note: library usage is not semver/API-stable

Type evolution of a websocat run:

  1. &str - string as passed to command line
  2. Specifier - more organized representation, maybe nested
  3. PeerConstructor - a future or stream that returns one or more connections
  4. Peer - one active connection
  5. Transfer - two peers recombine into two (if bidirectional) transfers
  6. Session - a running websocat connection from one specifier to another

Re-exports

pub use lints::ConfigurationConcern;
pub use specparse::boxup;
pub use specparse::spec;

Modules

connection_reuse_peer
file_peer
lints
mirror_peer
net_peer
process_peer
reconnect_peer
specparse
stdio_peer
stdio_threaded_peer
trivial_peer
unix_peer
ws_client_peer
ws_peer
ws_server_peer

Structs

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)).

Functions

box_up_err
multi
once
peer_err
peer_err_s
peer_from_str
peer_strerr
serve

Type Definitions

BoxedNewPeerFuture
BoxedNewPeerStream