Struct CommandBuilder 

pub struct CommandBuilder<Cmd> { /* private fields */ }

Builds MikroTik router commands using a fluid API.

Ensures that only commands with at least one operation can be built and sent.

Examples

let cmd = CommandBuilder::new()
    .command("/system/resource/print")
    .attribute("detail", None)
    .build();

Implementations

impl CommandBuilder<NoCmd>

pub fn new() -> Self

Begin building a new Command with a randomly generated tag.

pub fn with_tag(tag: u16) -> Self

Begin building a new Command with a specified tag.

Arguments

• tag - A u16 tag value that identifies the command for RouterOS correlation. Must be unique.

Examples

let builder = CommandBuilder::with_tag(1234);

pub fn login(username: &str, password: Option<&str>) -> Command

Builds a login command with the provided username and optional password.

Arguments

• username - The username for the login command.
• password - An optional password for the login command.

Returns

A Command which represents the login operation.

Examples

let login_cmd = CommandBuilder::login("admin", Some("password"));

pub fn cancel(tag: u16) -> Command

Builds a command to cancel a specific running command identified by tag.

Arguments

• tag - The tag of the command to be canceled.

Returns

A Command which represents the cancel operation.

Examples

let cancel_cmd = CommandBuilder::cancel(1234);

pub fn command(self, command: &str) -> CommandBuilder<Cmd>

Specify the command to be executed.

Arguments

• command - The MikroTik command to execute.

Returns

The builder transitioned to the Cmd state for attributes configuration.

impl CommandBuilder<Cmd>

pub fn attribute(self, key: &str, value: Option<&str>) -> Self

Adds an attribute to the command being built.

Arguments

• key - The attribute’s key.
• value - The attribute’s value, which is optional. If None, the attribute is treated as a flag (e.g., =key=).

Returns

The builder with the attribute added, allowing for method chaining.

pub fn attribute_raw(self, key: &str, value: Option<&[u8]>) -> Self

Adds an attribute with a raw byte value to the command being built.

Use this method when your attribute values might contain non-UTF-8 or binary data. For regular string values, CommandBuilder<Cmd>::attribute provides a more convenient interface.

Arguments

• key - The attribute’s key (must be valid UTF-8).
• value - The attribute’s value as raw bytes, which is optional. If None, the attribute is treated as a flag.

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_is_present(self, name: &str) -> Self

Adds a query to the command being built. pushes ‘true’ if an item has a value of property name, ‘false’ if it does not.

#Arguments

• name: name of the property to check

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_not_present(self, name: &str) -> Self

Adds a query to the command being built. pushes ‘true’ if an item has a value of property name, ‘false’ if it does not.

#Arguments

• name: name of the property to check

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_equal(self, name: &str, value: &str) -> Self

Adds a query to the command being built. pushes ‘true’ if the property name has a value equal to x, ‘false’ otherwise.

#Arguments

• name: name of the property to compare
• value: value to be compared with

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_gt(self, key: &str, value: &str) -> Self

Adds a query to the command being built. pushes ‘true’ if the property name has a value greater than x, ‘false’ otherwise.

#Arguments

• name: name of the property to compare
• value: value to be compared with

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_lt(self, key: &str, value: &str) -> Self

Adds a query to the command being built. pushes ‘true’ if the property name has a value less than x, ‘false’ otherwise.

#Arguments

• name: name of the property to compare
• value: value to be compared with

Returns

The builder with the attribute added, allowing for method chaining.

pub fn query_operations( self, operations: impl Iterator<Item = QueryOperator>, ) -> Self

defines combination of defined operations https://help.mikrotik.com/docs/spaces/ROS/pages/47579160/API#API-Queries #Arguments

• operations: operation sequence to be applied to the results on the stack

Returns

The builder with the attribute added, allowing for method chaining.

pub fn build(self) -> Command

Finalizes the command construction process, producing a Command.

Returns

A Command instance ready for execution.

Trait Implementations

impl<Cmd: Clone> Clone for CommandBuilder<Cmd>

fn clone(&self) -> CommandBuilder<Cmd>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CommandBuilder<NoCmd>

fn default() -> Self

Returns the “default value” for a type.