Struct DialStringTarget 

pub struct DialStringTarget { /* private fields */ }

Where a dial string is headed: the command carrying it, the block-parser revision of the switch reading it, and the split cutting that command’s arguments.

Implementations

impl DialStringTarget

pub fn new(carrier: DialStringCarrier) -> Self

Target carrier at the default BlockParse.

pub fn with_argv_separator( self, sep: char, ) -> Result<Self, InvalidArgvSeparator>

Split originate’s arguments on sep, as a line opening with ^^<sep> asks the switch.

The dial string is one argument of that split: rendered, it is escaped once for the split’s cleanup; parsed, that cleanup runs first and a second argument is refused.

Refused: separators the switch splits or unescapes wrongly (space, \, ', lowercase n r t s, controls, non-ASCII) and, as policy, ^ " , | [ ] { } < > = :, which read as dial-string grammar or quoting, and every other letter or digit, which reads as part of a word. A ' separator pairs with the next one as quotes.

pub fn argv_separator(&self) -> Option<char>

The separator cutting originate’s arguments in place of the blank split.

pub fn escape_argument<'a>(&self, text: &'a str) -> Option<Cow<'a, str>>

text escaped as one argument of originate’s split, on blanks or on the argv_separator, or None at a carrier that splits none.

An empty text is written '', which the split keeps as an argument. On blanks a text opening ^^ is written after '', since a line opening ^^ names its own separator.

pub fn with_block_parse(self, block_parse: BlockParse) -> Self

Target a switch running block_parse.

pub fn carrier(&self) -> DialStringCarrier

The command carrying the dial string.

pub fn block_parse(&self) -> BlockParse

The block-parser revision rendered for.

Trait Implementations

impl Clone for DialStringTarget

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DialStringTarget

impl Debug for DialStringTarget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DialStringTarget

impl From<DialStringCarrier> for DialStringTarget

fn from(carrier: DialStringCarrier) -> Self

Converts to this type from the input type.

impl PartialEq for DialStringTarget

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DialStringTarget