Struct mpd_protocol::command::Command

pub struct Command { /* fields omitted */ }

A command or a command list consisting of multiple commands, which can be sent to MPD.

The primary way to create Commands is to use the various TryFrom implementations, or the new function (which panics instead of returning results).

Methods

impl Command

pub fn new<C>(c: C) -> Self where
    C: TryInto<Self>,
    <C as TryInto<Self>>::Error: Debug, 

Create a new command, but panic instead of returning a Result when the conversion fails.

This may be useful in cases where you supply known-good commands for simplicity.

use mpd_protocol::Command;

let command = Command::new("status");

assert_eq!(command.render(), "status\n");

Panics on invalid values:

use mpd_protocol::Command;

// This panics
Command::new("invalid\ncommand");

pub fn from_parts(
    command: &str,
    arguments: &[&str]
) -> Result<Self, CommandError>

Create a command from the given base command and a list of arguments.

The arguments will be joined into a single command, and quoted and escaped if necessary.

use mpd_protocol::Command;

assert_eq!(
    Command::from_parts("hello", &["foo", "bar baz", "Foo's Bar"][..]).unwrap().render(),
    "hello foo \"bar baz\" \"Foo\\'s Bar\"\n"
);

pub fn render(self) -> String

Render the command to the wire representation. Commands are automatically wrapped in command lists if necessary.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Eq for Command

impl Hash for Command

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Command> 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: &Command) -> bool

This method tests for !=.

impl StructuralEq for Command

impl StructuralPartialEq for Command

impl<'_, '_> TryFrom<&'_ [&'_ str]> for Command

type Error = CommandError

The type returned in the event of a conversion error.

fn try_from(commands: &[&str]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Command

type Error = CommandError

The type returned in the event of a conversion error.

fn try_from(c: &str) -> Result<Self, Self::Error>

Performs the conversion.