Souvlaki

https://docs.rs/souvlaki/0.8.3/souvlaki/
Admin
Souvlaki is a cross-platform Rust library for handling OS media controls and metadata across Linux,...
Tokens:7,245
Snippets:96
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Playerctl Metadata Example

Source: https://docs.rs/souvlaki

This example shows how to use the `playerctl` command-line tool to display metadata from a player, likely interacting with the souvlaki library on Linux.

```bash
# In one shell
$ cd souvlaki 
$ cargo run --example window

# In another shell
$ playerctl metadata
my_player xesam:artist              Slowdive
my_player xesam:album               Souvlaki
my_player mpris:artUrl              https://c.pxhere.com/photos/34/c1/souvlaki_authentic_greek_greek_food_mezes-497780.jpg!d
my_player mpris:trackid             '/'
my_player mpris:length              290000000
my_player xesam:title               When The Sun Hits
```

--------------------------------

### Basic MediaControls Usage Example

Source: https://docs.rs/souvlaki

This example demonstrates creating MediaControls, attaching an event listener, setting metadata, and keeping the application running. It includes platform-specific handling for window handles.

```rust
use souvlaki::{MediaControlEvent, MediaControls, MediaMetadata, PlatformConfig};

fn main() {
    #[cfg(not(target_os = "windows"))]
    let hwnd = None;

    #[cfg(target_os = "windows")]
    let hwnd = {
        use raw_window_handle::windows::WindowsHandle;

        let handle: WindowsHandle = unimplemented!();
        Some(handle.hwnd)
    };

    let config = PlatformConfig {
        dbus_name: "my_player",
        display_name: "My Player",
        hwnd,
    };

    let mut controls = MediaControls::new(config).unwrap();

    // The closure must be Send and have a static lifetime.
    controls
        .attach(|event: MediaControlEvent| println!("Event received: {:?}", event))
        .unwrap();

    // Update the media metadata.
    controls
        .set_metadata(MediaMetadata {
            title: Some("Souvlaki Space Station"),
            artist: Some("Slowdive"),
            album: Some("Souvlaki"),
            ..Default::default()
        })
        .unwrap();

    // Your actual logic goes here.
    loop {
        std::thread::sleep(std::time::Duration::from_secs(1));
    }

    // The controls automatically detach on drop.
}
```

--------------------------------

### TryInto Implementation Example

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

This snippet demonstrates the TryInto trait implementation for generic types, allowing for fallible conversions into other types.

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

--------------------------------

### Implement ToString for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Converts any type T that implements Display into a String. This is a convenient way to get a string representation of a value.

```rust
impl<T> ToString for T where T: Display + ?Sized {
    fn to_string(&self) -> String {
        // ...
    }
}
```

--------------------------------

### Create MediaControls Instance

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Initializes MediaControls with the specified platform configuration. Returns a Result indicating success or an Error.

```rust
pub fn new(config: PlatformConfig<'_>) -> Result<Self, Error>
```

--------------------------------

### Implement CloneToUninit (Nightly)

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

An experimental nightly-only API for copying data to an uninitialized memory location. Use with caution.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### PlatformConfig Struct

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.PlatformConfig.html

Defines the OS-specific configuration required to create media controls.

```APIDOC
## PlatformConfig

### Description
OS-specific configuration needed to create media controls.

### Fields
- **display_name** (&str) - Required on Linux - The name to be displayed to the user.
- **dbus_name** (&str) - Required on Linux - Should follow the D-Bus spec.
- **hwnd** (Option<*mut c_void>) - Required on Windows - An HWND.
```

--------------------------------

### Implement PartialEq for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Enables comparison of MediaPosition values for equality using `==` and inequality using `!=`. This is fundamental for checking if two media positions are the same.

```rust
fn eq(&self, other: &MediaPosition) -> bool
```

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

--------------------------------

### MediaControls API

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Methods for initializing, managing, and updating OS media controls.

```APIDOC
## MediaControls API

### Description
Provides a handle to OS media controls for managing playback, metadata, and event handling.

### Methods

- **new(config: PlatformConfig)**: Create media controls with the specified config.
- **attach<F>(event_handler: F)**: Attach the media control events to a handler.
- **detach()**: Detach the event handler.
- **set_playback(playback: MediaPlayback)**: Set the current playback status.
- **set_metadata(metadata: MediaMetadata)**: Set the metadata of the currently playing media item.
- **set_volume(volume: f64)**: Set the volume level (0.0-1.0) (Only available on MPRIS).
```

--------------------------------

### Enable zbus backend for Souvlaki

Source: https://docs.rs/souvlaki

To use the zbus backend on Linux, disable default features and enable the 'use_zbus' feature in your Cargo.toml.

```toml
souvlaki = { version = "<version>", default-features = false, features = ["use_zbus"] }
```

--------------------------------

### Implement StructuralPartialEq for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides structural equality comparison for MediaPosition. This is often used in generic contexts.

```rust
impl StructuralPartialEq for MediaPosition
```

--------------------------------

### PartialEq Implementation for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Implements equality comparison (`==` and `!=`) for MediaMetadata structs.

```rust
fn eq(&self, other: &MediaMetadata<'a>) -> bool
```

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

--------------------------------

### MediaMetadata Trait Implementations

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

This section details the various trait implementations for the MediaMetadata struct, including Clone, Debug, Default, PartialEq, Eq, and several auto traits.

```APIDOC
## Trait Implementations for MediaMetadata

### Clone
- `clone(&self) -> MediaMetadata<'a>`: Returns a duplicate of the value.
- `clone_from(&mut self, source: &Self)`: Performs copy-assignment from `source`.

### Debug
- `fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### Default
- `default() -> MediaMetadata<'a>`: Returns the default value for the type.

### PartialEq
- `eq(&self, other: &MediaMetadata<'a>) -> bool`: Tests for equality between two `MediaMetadata` instances.
- `ne(&self, other: &Rhs) -> bool`: Tests for inequality between two `MediaMetadata` instances.

### Eq
This struct implements the `Eq` trait, indicating that equality is reflexive, symmetric, and transitive.

### Auto Trait Implementations
- `Freeze`
- `RefUnwindSafe`
- `Send`
- `Sync`
- `Unpin`
- `UnwindSafe`

### Blanket Implementations
- `Any`
- `Borrow<T>`
- `BorrowMut<T>`
- `CloneToUninit` (nightly-only experimental)
- `From<T>`
- `Into<U>`
- `ToOwned`
- `TryFrom<U>`
- `TryInto<U>`
```

--------------------------------

### Clone Implementation for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Provides the `clone` and `clone_from` methods for the MediaMetadata struct, allowing for duplication and assignment of metadata.

```rust
fn clone(&self) -> MediaMetadata<'a>
```

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

--------------------------------

### Structs

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/all.html

This section lists the available structs in the souvlaki crate.

```APIDOC
## Structs

### MediaControls
Represents controls for media playback.

### MediaMetadata
Contains metadata associated with media.

### MediaPosition
Indicates the current position within media playback.

### PlatformConfig
Configuration settings specific to the platform.
```

--------------------------------

### Implement CloneToUninit for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

A nightly-only experimental API for copying data to an uninitialized memory location. Requires the type T to implement Clone.

```rust
impl<T> CloneToUninit for T
where T: Clone,
```

--------------------------------

### Set Media Metadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Sets the metadata for the currently playing media item. Returns a Result indicating success or an Error.

```rust
pub fn set_metadata(&mut self, metadata: MediaMetadata<'_>) -> Result<(), Error>
```

--------------------------------

### StructuralPartialEq Implementation for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Indicates that MediaMetadata supports structural equality comparison.

```rust
impl<'a> StructuralPartialEq for MediaMetadata<'a>
```

--------------------------------

### Default Implementation for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Provides a default value for MediaMetadata, returning an instance with all fields set to `None` or their default.

```rust
fn default() -> MediaMetadata<'a>
```

--------------------------------

### Implement Clone for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides the ability to duplicate MediaPosition values. This is useful for creating copies without consuming the original.

```rust
fn clone(&self) -> MediaPosition
```

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

--------------------------------

### Implement From<T> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

A trivial implementation that returns the argument unchanged. Useful in generic contexts where a conversion is expected.

```rust
impl<T> From<T> for T {
    fn from(t: T) -> T {
        // ...
    }
}
```

--------------------------------

### Implement Any for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Provides dynamic type information for any type T that is 'static. This is a blanket implementation useful for trait objects.

```rust
impl<T> Any for T where T: 'static + ?Sized {
    fn type_id(&self) -> TypeId {
        // ...
    }
}
```

--------------------------------

### Attach Media Control Event Handler

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Attaches a closure to handle media control events. The handler must be Send and 'static. Returns a Result indicating success or an Error.

```rust
pub fn attach<F>(&mut self, event_handler: F) -> Result<(), Error>
where F: Fn(MediaControlEvent) + Send + 'static,
```

--------------------------------

### Implement Debug for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Allows MediaPosition instances to be formatted for debugging output. This is crucial for inspecting values during development.

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

--------------------------------

### Struct MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Represents an instant in a media item using a Duration.

```APIDOC
## Struct MediaPosition

### Description
An instant in a media item, represented as a wrapper around a `Duration`.

### Fields
- **0** (Duration) - The underlying duration representing the position.
```

--------------------------------

### PlatformConfig Struct Definition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.PlatformConfig.html

Defines the structure for OS-specific configuration. Required fields vary by OS: display_name and dbus_name for Linux, hwnd for Windows.

```rust
pub struct PlatformConfig<'a> {
    pub display_name: &'a str,
    pub dbus_name: &'a str,
    pub hwnd: Option<*mut c_void>,
}
```

--------------------------------

### Eq Implementation for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Marks MediaMetadata as having a total equivalence relation, a prerequisite for `Eq`.

```rust
impl<'a> Eq for MediaMetadata<'a>
```

--------------------------------

### Enums

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/all.html

This section lists the available enums in the souvlaki crate.

```APIDOC
## Enums

### Error
Represents possible errors that can occur.

### MediaControlEvent
Enumerates events related to media controls.

### MediaPlayback
Defines the states of media playback.

### SeekDirection
Specifies the direction for seeking within media.
```

--------------------------------

### Implement TryInto<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides a fallible conversion from type T to type U. This is the reciprocal of `TryFrom`.

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

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

--------------------------------

### Implement Copy for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Indicates that MediaPosition can be copied implicitly. This means assignments create a new independent value rather than moving ownership.

```rust
impl Copy for MediaPosition
```

--------------------------------

### OpenUri Variant Description

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

The OpenUri variant is used to open a specified URI within the media player.

```rust
OpenUri(String)
```

--------------------------------

### Define MediaMetadata Struct

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Defines the structure for media metadata, including optional string fields for title, album, artist, cover URL, and an optional Duration.

```rust
pub struct MediaMetadata<'a> {
    pub title: Option<&'a str>,
    pub album: Option<&'a str>,
    pub artist: Option<&'a str>,
    pub cover_url: Option<&'a str>,
    pub duration: Option<Duration>,
}
```

--------------------------------

### Implement Any for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Provides dynamic type information for any type T. This is part of Rust's trait system for runtime type identification.

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

--------------------------------

### Implement From<T> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides a way to create a value of type T from another value of the same type T. This is a simple identity conversion.

```rust
fn from(t: T) -> T
```

--------------------------------

### PartialEq Implementation for MediaControlEvent

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

This snippet shows the implementation of the PartialEq trait for MediaControlEvent, allowing for equality comparisons between enum variants.

```rust
fn eq(&self, other: &MediaControlEvent) -> bool
```

--------------------------------

### Implement Any for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides dynamic type information for any type T. This is part of the standard library's trait system for runtime type identification.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Set Media Playback Status

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Sets the current playback status of the media. Returns a Result indicating success or an Error.

```rust
pub fn set_playback(&mut self, playback: MediaPlayback) -> Result<(), Error>
```

--------------------------------

### Set Media Volume (MPRIS Only)

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Sets the volume level, ranging from 0.0 to 1.0. This functionality is only available on MPRIS. Returns a Result indicating success or an Error.

```rust
pub fn set_volume(&mut self, volume: f64) -> Result<(), Error>
```

--------------------------------

### Implement PartialEq for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Allows for equality comparison between SeekDirection values. This is essential for checking if two directions are the same.

```rust
impl PartialEq for SeekDirection
```

--------------------------------

### Implement TryInto<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Attempts to convert a value of type T into a value of type U. Returns a Result, indicating success or failure. This is the reciprocal of TryFrom.

```rust
impl<T, U> TryInto<U> for T where U: TryFrom<T> {
    type Error = <U as TryFrom<T>>::Error;
    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> {
        // ...
    }
}
```

--------------------------------

### Define MediaPlayback Enum

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaPlayback.html

Represents the status of media playback with optional progress information for paused or playing states.

```rust
pub enum MediaPlayback {
    Stopped,
    Paused {
        progress: Option<MediaPosition>,
    },
    Playing {
        progress: Option<MediaPosition>,
    },
}
```

--------------------------------

### Implement TryFrom<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Attempts to convert a value of type U into a value of type T. Returns a Result, indicating success or failure.

```rust
impl<T, U> TryFrom<U> for T where U: Into<T> {
    type Error = Infallible;
    fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> {
        // ...
    }
}
```

--------------------------------

### Auto Trait Implementations for MediaControlEvent

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

Details on the auto trait implementations for the MediaControlEvent enum.

```APIDOC
## Auto Trait Implementations for MediaControlEvent

*   `Freeze`
*   `RefUnwindSafe`
*   `Send`
*   `Sync`
*   `Unpin`
*   `UnwindSafe`
```

--------------------------------

### Implement Into<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Allows converting a value of type T into a value of type U, provided that U implements `From<T>`. This is the reciprocal of `From`.

```rust
fn into(self) -> U
```

--------------------------------

### Implement TryFrom<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Provides a fallible conversion from type U to type T. This is used when the conversion might fail.

```rust
type Error = Infallible
```

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

--------------------------------

### Implement TryInto<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Enables attempting a conversion from type T into type U, which may fail. This is the reciprocal of the TryFrom trait.

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

--------------------------------

### Implement From<Error> for Error

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Allows converting an existing Error into itself, typically used for error propagation or wrapping.

```rust
impl From<Error> for Error {
    fn from(source: Error) -> Self {
        // ...
    }
}
```

--------------------------------

### Implement TryFrom<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Allows attempting a conversion from type U to type T, which may fail. The associated `Error` type indicates the failure reason.

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

--------------------------------

### Trait Implementations for MediaControlEvent

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

Details on the trait implementations for the MediaControlEvent enum.

```APIDOC
## Trait Implementations for MediaControlEvent

### impl Clone for MediaControlEvent
#### fn clone(&self) -> MediaControlEvent
Returns a duplicate of the value.

#### fn clone_from(&mut self, source: &Self)
Performs copy-assignment from `source`.

### impl Debug for MediaControlEvent
#### fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.

### impl PartialEq for MediaControlEvent
#### fn eq(&self, other: &MediaControlEvent) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.

#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.

### impl StructuralPartialEq for MediaControlEvent
```

--------------------------------

### Implement Eq for MediaPosition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Marks MediaPosition as having a total equivalence relation. This is a marker trait that requires PartialEq to be implemented.

```rust
impl Eq for MediaPosition
```

--------------------------------

### Implement From<T> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Provides a way to convert a value of type T into itself. This is a trivial conversion where the value is returned unchanged.

```rust
impl<T> From<T> for T
```

--------------------------------

### Auto Trait Implementations for MediaMetadata

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Lists the auto trait implementations for MediaMetadata, indicating its thread safety and memory safety characteristics.

```rust
impl<'a> Freeze for MediaMetadata<'a>
```

```rust
impl<'a> RefUnwindSafe for MediaMetadata<'a>
```

```rust
impl<'a> Send for MediaMetadata<'a>
```

```rust
impl<'a> Sync for MediaMetadata<'a>
```

```rust
impl<'a> Unpin for MediaMetadata<'a>
```

```rust
impl<'a> UnwindSafe for MediaMetadata<'a>
```

--------------------------------

### Clone Implementation for MediaControlEvent

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

This snippet shows the implementation of the Clone trait for MediaControlEvent, allowing instances of the enum to be duplicated.

```rust
fn clone(&self) -> MediaControlEvent
```

--------------------------------

### Blanket Implementations for MediaControlEvent

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

Details on the blanket trait implementations for the MediaControlEvent enum.

```APIDOC
## Blanket Implementations for MediaControlEvent

### impl<T> Any for T
#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T
#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T
#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> CloneToUninit for T
#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`.

### impl<T> From<T> for T
#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T
#### fn into(self) -> U
Calls `U::from(self)`.

### impl<T> ToOwned for T
#### type Owned = T
#### fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning.

#### fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning.

### impl<T, U> TryFrom<U> for T
#### type Error = Infallible
#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

### impl<T, U> TryInto<U> for T
#### type Error = <U as TryFrom<T>>::Error
#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
```

--------------------------------

### Drop MediaControls Instance

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Implements the Drop trait for MediaControls, defining the behavior when the instance is dropped and its destructor is executed.

```rust
fn drop(&mut self)
```

--------------------------------

### Implement Borrow for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Allows borrowing a reference to T from an owned value of T. This is a fundamental trait for accessing data without taking ownership.

```rust
fn borrow(&self) -> &T
```

--------------------------------

### Implement Display for Souvlaki Error

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Enables the Error enum to be formatted as a user-friendly string. This is the recommended way to present errors to end-users.

```rust
impl Display for Error {
    fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result
}
```

--------------------------------

### Implement Into<U> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Enables conversion from type T into type U, provided that U implements From<T>. This is the reciprocal of the From trait.

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

--------------------------------

### Borrow and BorrowMut Trait Implementations

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

Implements `Borrow` and `BorrowMut` traits, enabling immutable and mutable borrowing of the type.

```rust
fn borrow(&self) -> &T
```

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

--------------------------------

### Implement StructuralPartialEq for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Provides structural equality comparison for SeekDirection. This trait is often used in generic contexts where structural equality is needed.

```rust
impl StructuralPartialEq for SeekDirection
```

--------------------------------

### TryFrom Trait Implementation

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.PlatformConfig.html

Implements the TryFrom trait for fallible conversions.

```rust
type Error = Infallible

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

--------------------------------

### SetVolume Variant Description

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

The SetVolume variant is used to set the volume of the media player. The value is typically between 0.0 and 1.0, but other values are accepted. It is crucial to call MediaControls::set_volume after receiving and handling this event, especially with the MPRIS backend.

```rust
SetVolume(f64)
```

--------------------------------

### TryInto Trait Implementation

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.PlatformConfig.html

Implements the TryInto trait for fallible conversions.

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

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

--------------------------------

### MediaControls Struct Definition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Defines the MediaControls struct, which serves as a handle to OS media controls. It has private fields.

```rust
pub struct MediaControls { /* private fields */ }
```

--------------------------------

### MediaMetadata Struct

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaMetadata.html

The MediaMetadata struct represents the metadata of a media item, including title, album, artist, cover URL, and duration.

```APIDOC
## Struct MediaMetadata

### Description
The metadata of a media item.

### Fields
- **title** (Option<&'a str>) - The title of the media item.
- **album** (Option<&'a str>) - The album the media item belongs to.
- **artist** (Option<&'a str>) - The artist of the media item.
- **cover_url** (Option<&'a str>) - The URL of the cover art for the media item. This field is platform-specific.
- **duration** (Option<Duration>) - The duration of the media item.
```

--------------------------------

### Implement Copy for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Indicates that SeekDirection values can be copied implicitly. This is suitable for simple types like enums that do not require deep copying.

```rust
impl Copy for SeekDirection
```

--------------------------------

### Implement Borrow for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Allows a type T to be borrowed immutably as a reference to another type T. This is a fundamental trait for borrowing in Rust.

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

--------------------------------

### Define MediaPosition Struct

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Defines the MediaPosition struct which holds a Duration. This is the primary way to represent a point in time within media content.

```rust
pub struct MediaPosition(pub Duration);
```

--------------------------------

### Implement BorrowMut for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Allows borrowing a mutable reference to T from an owned value of T. This enables in-place modification of data.

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

--------------------------------

### Implement Borrow<T> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Allows immutable borrowing of a value of type T. This is a fundamental trait for accessing data without taking ownership.

```rust
impl<T> Borrow<T> for T where T: ?Sized {
    fn borrow(&self) -> &T {
        // ...
    }
}
```

--------------------------------

### MediaPlayback Enum Definition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaPlayback.html

The MediaPlayback enum represents the current playback state of a media source.

```APIDOC
## MediaPlayback Enum

### Description
The status of media playback, indicating whether the media is stopped, paused, or currently playing.

### Variants
- **Stopped**: The media playback is currently stopped.
- **Paused**: The media playback is paused. Contains an optional `progress` field of type `MediaPosition`.
- **Playing**: The media playback is active. Contains an optional `progress` field of type `MediaPosition`.

### Data Structure
```rust
pub enum MediaPlayback {
    Stopped,
    Paused {
        progress: Option<MediaPosition>,
    },
    Playing {
        progress: Option<MediaPosition>,
    },
}
```
```

--------------------------------

### Implement BorrowMut for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Allows a type T to be borrowed mutably as a mutable reference to another type T. This is used for mutable borrowing operations.

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

--------------------------------

### Implement std::error::Error for Souvlaki Error

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Provides standard error handling capabilities for the Error enum, including accessing the source error and a description.

```rust
impl Error for Error {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        // ...
    }
    fn description(&self) -> &str {
        // ...
    }
    fn cause(&self) -> Option<&dyn Error> {
        // ...
    }
    fn provide<'a>(&'a self, request: &mut Request<'a>) {
        // ...
    }
}
```

--------------------------------

### Implement Debug for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Enables the debugging representation of the SeekDirection enum, allowing it to be formatted for debugging purposes.

```rust
impl Debug for SeekDirection
```

--------------------------------

### Implement Debug for Souvlaki Error

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Allows the Error enum to be formatted for debugging purposes. This is automatically derived and useful for logging or inspecting errors.

```rust
impl Debug for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
}
```

--------------------------------

### Define MediaControlEvent Enum

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

This enum defines the possible events that can be received from OS media controls. Variants include playback commands, seeking, volume changes, and URI opening.

```rust
pub enum MediaControlEvent {
    Play,
    Pause,
    Toggle,
    Next,
    Previous,
    Stop,
    Seek(SeekDirection),
    SeekBy(SeekDirection, Duration),
    SetPosition(MediaPosition),
    SetVolume(f64),
    OpenUri(String),
    Raise,
    Quit,
}
```

--------------------------------

### Implement ToOwned for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaPosition.html

Enables creating an owned version of a borrowed type, typically by cloning. This is useful when you need ownership from a reference.

```rust
type Owned = T
```

```rust
fn to_owned(&self) -> T
```

```rust
fn clone_into(&self, target: &mut T)
```

--------------------------------

### Implement BorrowMut<T> for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Enables mutable borrowing of a value of type T. This is essential for modifying data in place.

```rust
impl<T> BorrowMut<T> for T where T: ?Sized {
    fn borrow_mut(&mut self) -> &mut T {
        // ...
    }
}
```

--------------------------------

### Implement Clone for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Provides the ability to create a duplicate of a SeekDirection value. This is a standard trait implementation for enums that represent simple states.

```rust
impl Clone for SeekDirection
```

--------------------------------

### Detach Media Control Event Handler

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/struct.MediaControls.html

Detaches the currently attached event handler. Returns a Result indicating success or an Error.

```rust
pub fn detach(&mut self) -> Result<(), Error>
```

--------------------------------

### SeekBy Variant Description

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

The SeekBy variant is used to seek forward or backward by a specific amount. It requires a SeekDirection and a Duration.

```rust
SeekBy(SeekDirection, Duration)
```

--------------------------------

### Implement ToOwned for T

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Facilitates creating an owned version of a borrowed type. This is commonly used for cloning data from references.

```rust
impl<T> ToOwned for T
where T: Clone,
```

--------------------------------

### Implement Eq for SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Marks SeekDirection as having a total equivalence relation. This is a marker trait that is automatically derived when PartialEq is implemented for types with total equality.

```rust
impl Eq for SeekDirection
```

--------------------------------

### MediaControlEvent Enum

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.MediaControlEvent.html

The MediaControlEvent enum represents events sent by the OS media controls.

```APIDOC
## Enum MediaControlEvent

### Description
Events sent by the OS media controls.

### Variants
*   `Play`
*   `Pause`
*   `Toggle`
*   `Next`
*   `Previous`
*   `Stop`
*   `Seek(SeekDirection)` - Seek forward or backward by an undetermined amount.
*   `SeekBy(SeekDirection, Duration)` - Seek forward or backward by a certain amount.
*   `SetPosition(MediaPosition)` - Set the position/progress of the currently playing media item.
*   `SetVolume(f64)` - Sets the volume. The value is intended to be from 0.0 to 1.0. But other values are also accepted. It is up to the user to set constraints on this value. NOTE: If the volume event was received and correctly handled, the user must call `MediaControls::set_volume`. Note that this must be done only with the MPRIS backend.
*   `OpenUri(String)` - Open the URI in the media player.
*   `Raise` - Bring the media player’s user interface to the front using any appropriate mechanism available.
*   `Quit` - Shut down the media player.
```

--------------------------------

### Souvlaki Error Enum Definition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

Defines the possible errors that can occur within the Souvlaki library. Use this enum to handle specific error conditions like D-Bus issues or thread problems.

```rust
pub enum Error {
    DbusError(Error),
    ThreadNotRunning,
    ThreadPanicked,
}
```

--------------------------------

### Error Enum Definition

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.Error.html

The Error enum defines the possible error states for the souvlaki library.

```APIDOC
## Error Enum

### Description
A platform-specific error type used by the souvlaki crate to handle various failure scenarios.

### Variants
- **DbusError(Error)** - An error originating from D-Bus communication.
- **ThreadNotRunning** - Indicates that the required background thread is not currently running.
- **ThreadPanicked** - Indicates that the background thread has panicked.
```

--------------------------------

### Define SeekDirection Enum

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

Defines the possible directions for seeking operations: Forward and Backward. This enum is used to control the direction of search or iteration.

```rust
pub enum SeekDirection {
    Forward,
    Backward,
}
```

--------------------------------

### Enum SeekDirection

Source: https://docs.rs/souvlaki/0.8.3/souvlaki/enum.SeekDirection.html

The SeekDirection enum represents the direction to seek in, containing variants for Forward and Backward movement.

```APIDOC
## Enum SeekDirection

### Description
The direction to seek in.

### Variants
- **Forward**
- **Backward**

### Trait Implementations
- **Clone**: Returns a duplicate of the value.
- **Debug**: Formats the value using the given formatter.
- **PartialEq**: Tests for equality between two SeekDirection values.
- **Eq**: Indicates that the type implements equality.
- **Copy**: Allows the type to be copied.
```
Tokens:
Raw