Crate websocat

source · [−]

Expand description

Note: library usage is not semver/API-stable

Type evolution of a websocat run:

&str - string as passed to command line. When it meets the list of SpecifierClasses, there appears:
SpecifierStack - specifier class, final string argument and vector of overlays.
Specifier - more rigid version of SpecifierStack, with everything parsable parsed. May be nested. When construct is called, we get:
PeerConstructor - a future or stream that returns one or more connections. After completion, we get one or more of:
Peer - an active connection. Once we have two of them, we can start a:
Session with two Transfers - forward and reverse.

Re-exports

pub use http_bytes::http;

pub use crate::options::Options;

pub use crate::specifier::ClassMessageBoundaryStatus;

pub use crate::specifier::ClassMulticonnectStatus;

pub use crate::specifier::ConstructParams;

pub use crate::specifier::Specifier;

pub use crate::specifier::SpecifierClass;

pub use crate::specifier::SpecifierStack;

pub use crate::util::brokenpipe;

pub use crate::util::io_other_error;

pub use crate::util::simple_err2;

pub use crate::util::wouldblock;

pub use crate::util::box_up_err;

pub use crate::util::multi;

pub use crate::util::once;

pub use crate::util::peer_err;

pub use crate::util::peer_err_s;

pub use crate::util::peer_strerr;

pub use crate::util::simple_err;

pub use crate::specparse::spec;

pub use crate::sessionserve::serve;

Structs

LeftSpecToRightSpec

Some information passed from the left specifier Peer to the right

WebsocatConfiguration1

First representation of websocat command-line, partially parsed.

WebsocatConfiguration2

Second representation of websocat configuration: everything (e.g. socket addresses) should already be parsed and verified A structural form: two chains of specifier nodes. Futures/async is not yet involved at this stage, but everything should be checked and ready to do to start it (apart from OS errors)

WebsocatConfiguration3

An immutable chain of fucntions that results in a Futures or Streams that rely on each other. This is somewhat like a frozen form of WebsocatConfiguration2.