Struct automaat_processor_redis_command::RedisCommand

pub struct RedisCommand {
    pub command: String,
    pub arguments: Option<Vec<String>>,
    pub url: Url,
}

The processor configuration.

Fields

command: String

The main Redis command to execute.

See the main Redis documentation for a list of available commands.

arguments: Option<Vec<String>>

The arguments belonging to the main command.

The acceptable value of these arguments depends on the command being executed.

url: Url

The URL of the Redis server.

See the redis-rs "connection parameters" documentation for more details.

Trait Implementations

impl Eq for RedisCommand

impl PartialEq<RedisCommand> for RedisCommand

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

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

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

This method tests for !=.

impl Clone for RedisCommand

fn clone(&self) -> RedisCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RedisCommand

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

Formats the value using the given formatter.

impl<'a> Processor<'a> for RedisCommand

const NAME: &'static str

The human-formatted name of the processor, used to visually identify this processor amongst others.

type Error = Error

If a processor fails its intended purpose, the returned error is turned into a string, and shown in the automaat-web-client application.

type Output = String

The processor can return any (successful) output it wants, as long as that type implements the [std::fmt::Display] trait.

fn run(&self, _context: &Context) -> Result<Option<Self::Output>, Self::Error>

Run the configured Redis command, and return its results.

Output

The value returned by the Redis server is fairly untyped, and not always easily represented in the final output. In general, the most common values are correctly mapped, such as Nil becoming None, and all valid UTF-8 data is returned as Some, containing the data as a string.

Any value that cannot be coerced into a valid UTF-8 string, is represented in the best possible way as a valid UTF-8 string, but won't completely match the original output of Redis.

Errors

See the Error enum for all possible error values that can be returned. These values wrap the redis::ErrorKind values.

fn validate(&self) -> Result<(), Self::Error>

The validate method is used by the automaat-server application to do a runtime check to make sure that the processor is correctly configured before running it.

impl<'de> Deserialize<'de> for RedisCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for RedisCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.