Connection

Struct Connection 

Source
pub struct Connection<IO> { /* private fields */ }
Expand description

A blocking connection to an MPD server.

Implementations§

Source§

impl<IO> Connection<IO>

Source

pub fn connect(io: IO) -> Result<Connection<IO>, MpdProtocolError>
where IO: Read,

Connect to an MPD server synchronously.

Source

pub fn send(&mut self, command: Command) -> Result<(), MpdProtocolError>
where IO: Write,

Send a command.

§Errors

This will return an error if writing to the given IO resource fails.

Source

pub fn send_list( &mut self, command_list: CommandList, ) -> Result<(), MpdProtocolError>
where IO: Write,

Send a command list.

§Errors

This will return an error if writing to the given IO resource fails.

Source

pub fn receive(&mut self) -> Result<Option<Response>, MpdProtocolError>
where IO: Read,

Receive a response from the server.

This will return Ok(Some(..)) when a complete response has been received, or Ok(None) if the connection is closed cleanly.

§Errors

This will return an error if:

  • Reading from the given IO resource returns an error
  • Malformed response data is received
  • The connection is closed while a response is in progress
Source

pub fn command( &mut self, command: Command, ) -> Result<Response, MpdProtocolError>
where IO: Read + Write,

Send a command and receive its response.

This is essentially a shorthand for Connection::send followed by Connection::receive.

§Errors

This will return an error if:

  • Writing to or reading from the connection returns an error
  • Malformed response data is received
  • The connection is closed
Source

pub fn command_list( &mut self, command_list: CommandList, ) -> Result<Response, MpdProtocolError>
where IO: Read + Write,

Send a command list and receive its response(s).

This is essentially a shorthand for Connection::send_list followed by Connection::receive.

§Errors

This will return an error if:

  • Writing to or reading from the connection returns an error
  • Malformed response data is received
  • The connection is closed
Source

pub fn protocol_version(&self) -> &str

Returns the protocol version the server is using.

Source

pub fn into_inner(self) -> IO

Extract the connection instance.

Trait Implementations§

Source§

impl<IO: Debug> Debug for Connection<IO>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<IO> Freeze for Connection<IO>
where IO: Freeze,

§

impl<IO> RefUnwindSafe for Connection<IO>
where IO: RefUnwindSafe,

§

impl<IO> Send for Connection<IO>
where IO: Send,

§

impl<IO> Sync for Connection<IO>
where IO: Sync,

§

impl<IO> Unpin for Connection<IO>
where IO: Unpin,

§

impl<IO> UnwindSafe for Connection<IO>
where IO: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more