![Latest Version] ![Build Status]
MusicBrainz rust is a utility crate for the the MusicBrainz API.
you may be looking for : - Api documention - The crate
To perform a lookups via fetch queries,
you need to import the Fetch
trait. This can be done using musicbrainz_rs::prelude
```rust extern crate musicbrainz_rs;
use musicbrainzrs::model::artist; use musicbrainzrs::model::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());
} ```
You can also use includes to get more detail about a resource :
Every Musicbrainz resource has allowed include parameters.
```rust extern crate musicbrainz_rs;
use musicbrainzrs::model::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());
} ```
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 extern crate musicbrainz_rs;
use musicbrainzrs::model::artist; use musicbrainzrs::model::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));
} ```
Use musicbrainz_rs::Search
to perform a search query.
```rust extern crate musicbrainz_rs;
use musicbrainzrs::model::artist::Artist; use musicbrainzrs::prelude::*;
fn main() { musicbrainzrs::config::setuseragent("myawesome_app/1.0");
let query = Artist::query_builder()
.name("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()));
} ```
You can set your application user-agent as recommended in the musicbrainz documentation :
```rust extern crate musicbrainz_rs;
use musicbrainzrs::model::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());
} ```
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
All contributions are welcome, if find a bug or have a feature request don't hesitate to open an issue!
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.