Struct shortcut_autotyper::Command

pub struct Command { /* private fields */ }

Basic structure containing name and number of repetition.

Implementations

impl Command

pub fn new(name: &str) -> Command

Create new Command with only one repetition.

• name is given name and does not have to be valid

pub fn new_number(name: &str, num: usize) -> Command

Create new Command with given number of repetitions.

• name is given name and does not have to be valid
• num is the number of repetitions

pub fn new_range(name: &str, range: Range<usize>) -> Command

Create new Command with number of repetitions randomly selected from given range.

• name is given name and have not to be valid
• range is a half-open range of possible repetitions

let cmd = Command::new_range("A", 3..5);
let times = cmd.get_times();
assert!(times >= 3);
assert!(times < 5);

pub fn valid(&self) -> ATResult<()>

Check if self structure have valid name.

pub fn valid_name(name: &str) -> ATResult<()>

Check if given name is valid. A valid name can consist only of alphabetical characters. If given name is not valid, then it returns an error with ErrType::InvalidKeyFormat.

assert_eq!(Command::valid_name("A"), Ok(()));
assert_eq!(
    Command::valid_name("A~"),
    Err(ErrType::InvalidKeyFormat(String::from("A~")).into())
);
assert_eq!(
    Command::valid_name("A B"),
    Err(ErrType::InvalidKeyFormat(String::from("A B")).into())
);

pub fn are_valid_names<'a, I: Iterator<Item = &'a String>>( iter: I ) -> ATVecResult<()>

Check if given names are valid same as Command::valid_name() and returns a Vec of ErrType::InvalidKeyFormat.

• iter is iterator of given names

pub fn get_times(&self) -> usize

Return number of repetition of command, for range return one of random possible options.

pub fn get_name(&self) -> &str

Return reference to name of the command.

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl Display for Command

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

Formats the value using the given formatter.

impl FromStr for Command

type Err = ErrAutoType

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Command

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Command

impl StructuralPartialEq for Command