![MusicBrainz] Rust  

![Latest Version] ![Build Status]

MusicBrainz rust is a utility crate for the the MusicBrainz API.

you may be looking for : - Api documention - The crate

Usage

You can choose to use either the default async client or a blocking one.

async client: toml musicbrainz_rs = "0.5.0"

blocking client: toml musicbrainz_rs = { version = "0.5.0", features = ["blocking] }

Features

Note: All the example below use the blocking feature for the sake of conciseness.

Fetch query

To perform a lookups via fetch queries, you need to import the Fetch trait. This can be done using musicbrainz_rs::prelude

```rust use musicbrainzrs::entity::artist; use musicbrainzrs::entity::artist::; use musicbrainz_rs::prelude::;

fn main() { let nirvana = Artist::fetch() .id("5b11f4ce-a62d-471e-81fc-a69a8278c7da") .execute();

assert_eq!(nirvana.unwrap().name, "Nirvana".to_string());

} ```

Include parameters

You can also use includes to get more detail about a resource :

Every Musicbrainz resource has allowed include parameters.

```rust use musicbrainzrs::entity::label::*; use musicbrainzrs::prelude::*;

fn main() { let ninjatune = Label::fetch() .id("dc940013-b8a8-4362-a465-291026c04b42") .withtags() .with_ratings() .execute() .unwrap();

assert!(ninja_tune
    .tags
    .unwrap()
    .iter()
    .any(|tag| tag.name == "independent"));

assert!(ninja_tune.rating.is_some());

} ```

CoverArt query

Release and ReleaseGroup entities in MusicBrainz also allow you to make CoverArt queries on them:

```rust use musicbrainzrs::entity::release::*; use musicbrainzrs::entity::CoverartResponse; use musicbrainzrs::prelude::*; use musicbrainzrs::FetchCoverart;

fn main() { // CoverArt Query for a Release. let inuterocoverart = Release::fetch_coverart() .id("76df3287-6cda-33eb-8e9a-044b5e15ffdd") .execute() .expect("Unable to get cover art");

if let CoverartResponse::Json(coverart) = in_utero_coverart {
    assert!(!coverart.images[0].back);
    assert_eq!(
        coverart.images[0].image,
        "http://coverartarchive.org/release/76df3287-6cda-33eb-8e9a-044b5e15ffdd/829521842.jpg"
    );
} else {
    assert!(false);
}

let in_utero = Release::fetch()
    .id("76df3287-6cda-33eb-8e9a-044b5e15ffdd")
    .execute()
    .expect("Unable to get release");

// Calling `get_coverart()` method on an already fetched Release entity.
let in_utero_coverart = in_utero
    .get_coverart()
    .execute()
    .expect("Unable to get coverart");

if let CoverartResponse::Json(coverart) = in_utero_coverart {
    assert!(!coverart.images[0].back);
    assert_eq!(
        coverart.images[0].image,
        "http://coverartarchive.org/release/76df3287-6cda-33eb-8e9a-044b5e15ffdd/829521842.jpg"
    );
} else {
    assert!(false);
}

// CoverArt Query Builder to fetch a specific resource.
let in_utero_500px_front_coverart = Release::fetch_coverart()
    .id("76df3287-6cda-33eb-8e9a-044b5e15ffdd")
    .res_500()
    .back()
    .execute()
    .expect("Unable to get cover art");

if let CoverartResponse::Url(coverart_url) = in_utero_500px_front_coverart {
    println!("{}", coverart_url);
} else {
    assert!(false);
}

} ```

Browse query

Use musicbrainz_rs::Browse or bring it in scope using musicbrainz_rs::prelude to perform a browse query. Just like Include every muscibrainz resource has allowable linked entities for such queries.

```rust use musicbrainzrs::entity::artist; use musicbrainzrs::entity::artist::Artist; use musicbrainz_rs::prelude::*;

fn main() { let artistsoninuterorelease = Artist::browse() .by_release("18d4e9b4-9247-4b44-914a-8ddec3502103") .execute();

let artists_on_in_utero_release = artists_on_in_utero_release.unwrap();

artists_on_in_utero_release
    .entities
    .iter()
    .for_each(|artist| println!("{:?}", artist.name));

} ```

Search query

Use musicbrainz_rs::Search to perform a search query.

```rust use musicbrainzrs::entity::artist::Artist; use musicbrainzrs::prelude::*;

fn main() { musicbrainzrs::config::setuseragent("myawesome_app/1.0");

let query = Artist::query_builder()
    .artist("Miles Davis")
    .and()
    .country("US")
    .build();

let query_result = Artist::search(query).execute().unwrap();
let query_result: Vec<String> = query_result.entities
    .iter()
    .map(|artist| artist.name.clone()).collect();

assert!(query_result.contains(&"Miles Davis".to_string()));
assert!(query_result.contains(&"Miles Davis Quintet".to_string()));

} ```

Custom user agent

You can set your application user-agent as recommended in the musicbrainz documentation :

```rust use musicbrainzrs::entity::artist::Artist; use musicbrainzrs::prelude::*;

fn main() { musicbrainzrs::config::setuseragent("myawesome_app/1.0");

let nirvana = Artist::fetch()
    .id("5b11f4ce-a62d-471e-81fc-a69a8278c7da")
    .execute();

assert_eq!(nirvana.unwrap().name, "Nirvana".to_string());

} ```

Examples

To see what is currently implemented in the crate you can look at the tests directory.

You can run examples with cargo run --example example_name

Contributing

All contributions are welcome, if find a bug or have a feature request don't hesitate to open an issue!

Credits

Most of this crate documentation is taken from the official MusicBrainz doc, thanks to the MetaBrainz Foundation and its sponsors and supporters. Cover Art provided by the Cover Art Archive.