Trait websocat::specifier::SpecifierClass[][src]

pub trait SpecifierClass: Debug {
    fn get_name(&self) -> &'static str;
fn get_prefixes(&self) -> Vec<&'static str>;
fn help(&self) -> &'static str;
fn construct(&self, arg: &str) -> Result<Rc<dyn Specifier>, Box<dyn Error>>;
fn construct_overlay(
        &self,
        inner: Rc<dyn Specifier>
    ) -> Result<Rc<dyn Specifier>, Box<dyn Error>>;
fn is_overlay(&self) -> bool;
fn message_boundary_status(&self) -> ClassMessageBoundaryStatus;
fn multiconnect_status(&self) -> ClassMulticonnectStatus;
fn alias_info(&self) -> Option<&'static str>; }

A trait for a each specified type’s accompanying object

Don’t forget to register each instance at the list_of_all_specifier_classes macro.

Required methods

fn get_name(&self) -> &'static str[src]

The primary name of the class

fn get_prefixes(&self) -> Vec<&'static str>[src]

Names to match command line parameters against, with a : colon if needed

fn help(&self) -> &'static str[src]

–long-help snippet about this specifier

fn construct(&self, arg: &str) -> Result<Rc<dyn Specifier>, Box<dyn Error>>[src]

Given the command line text, construct the specifier arg is what comes after the colon (e.g. //echo.websocket.org in ws://echo.websocket.org)

fn construct_overlay(
    &self,
    inner: Rc<dyn Specifier>
) -> Result<Rc<dyn Specifier>, Box<dyn Error>>
[src]

Given the inner specifier, construct this specifier.

fn is_overlay(&self) -> bool[src]

Returns if this specifier is an overlay

fn message_boundary_status(&self) -> ClassMessageBoundaryStatus[src]

True if it is not expected to preserve message boundaries on reads

fn multiconnect_status(&self) -> ClassMulticonnectStatus[src]

fn alias_info(&self) -> Option<&'static str>[src]

If it is Some then is_overlay, construct and most other things are ignored and prefix get replaced…

Loading content...

Implementors

impl SpecifierClass for BroadcastReuserClass[src]

impl SpecifierClass for AppendFileClass[src]

impl SpecifierClass for ReadFileClass[src]

impl SpecifierClass for WriteFileClass[src]

impl SpecifierClass for ForeachmsgClass[src]

impl SpecifierClass for HttpClass[src]

impl SpecifierClass for HttpPostSseClass[src]

impl SpecifierClass for HttpRequestClass[src]

impl SpecifierClass for JsonRpcClass[src]

impl SpecifierClass for Line2MessageClass[src]

impl SpecifierClass for Message2LineClass[src]

impl SpecifierClass for LiteralReplyClass[src]

impl SpecifierClass for MirrorClass[src]

impl SpecifierClass for TcpConnectClass[src]

impl SpecifierClass for TcpListenClass[src]

impl SpecifierClass for UdpConnectClass[src]

impl SpecifierClass for UdpListenClass[src]

impl SpecifierClass for ReuserClass[src]

impl SpecifierClass for CmdClass[src]

impl SpecifierClass for ExecClass[src]

impl SpecifierClass for ShCClass[src]

impl SpecifierClass for AutoReconnectClass[src]

impl SpecifierClass for SocksBindClass[src]

impl SpecifierClass for SocksProxyClass[src]

impl SpecifierClass for AsyncStdioClass[src]

impl SpecifierClass for InetdClass[src]

impl SpecifierClass for OpenAsyncClass[src]

impl SpecifierClass for OpenFdAsyncClass[src]

impl SpecifierClass for StdioClass[src]

impl SpecifierClass for ThreadedStdioClass[src]

impl SpecifierClass for Assert2Class[src]

impl SpecifierClass for AssertClass[src]

impl SpecifierClass for CloggedClass[src]

impl SpecifierClass for LiteralClass[src]

impl SpecifierClass for LogClass[src]

impl SpecifierClass for AbstractConnectClass[src]

impl SpecifierClass for AbstractDgramClass[src]

impl SpecifierClass for AbstractListenClass[src]

impl SpecifierClass for UnixConnectClass[src]

impl SpecifierClass for UnixDgramClass[src]

impl SpecifierClass for UnixListenClass[src]

impl SpecifierClass for WsClientClass[src]

impl SpecifierClass for WsConnectClass[src]

impl SpecifierClass for WsLlClientClass[src]

impl SpecifierClass for WsLlServerClass[src]

impl SpecifierClass for WsAbstractUnixServerClass[src]

impl SpecifierClass for WsInetdServerClass[src]

impl SpecifierClass for WsServerClass[src]

impl SpecifierClass for WsTcpServerClass[src]

impl SpecifierClass for WsUnixServerClass[src]

Loading content...