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<Specifier>, Box<Error>>;

    fn construct_overlay(
        &self, 
        inner: Rc<Specifier>
    ) -> Result<Rc<Specifier>, Box<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

The primary name of the class

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

--long-help snippet about this specifier

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)

Given the inner specifier, construct this specifier.

Returns if this specifier is an overlay

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

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

Implementors