Struct radiobrowser::RadioBrowserAPI
source · pub struct RadioBrowserAPI { /* private fields */ }
Expand description
RadioBrowser client for async communication
It uses crate:async_std
Example
use std::error::Error;
use radiobrowser::RadioBrowserAPI;
#[async_std::main]
async fn main() -> Result<(), Box<dyn Error>> {
let mut api = RadioBrowserAPI::new().await?;
Ok(())
}
Implementations§
source§impl RadioBrowserAPI
impl RadioBrowserAPI
sourcepub async fn new() -> Result<Self, Box<dyn Error>>
pub async fn new() -> Result<Self, Box<dyn Error>>
Create a new instance of a radiobrowser api client. It will fetch a list of radiobrowser server with get_default_servers() and save it internally.
sourcepub async fn new_from_dns_a<P: AsRef<str>>(
dnsname: P
) -> Result<Self, Box<dyn Error>>
pub async fn new_from_dns_a<P: AsRef<str>>( dnsname: P ) -> Result<Self, Box<dyn Error>>
Create a new instance of a radiobrowser api client from a single dns name. Use this is you want to connect to a single named server.
sourcepub async fn new_from_dns_srv<P: AsRef<str>>(
srvname: P
) -> Result<Self, Box<dyn Error>>
pub async fn new_from_dns_srv<P: AsRef<str>>( srvname: P ) -> Result<Self, Box<dyn Error>>
Create a new instance of a radiobrowser api client from a dns srv record which may have multiple dns A/AAAA records.
pub async fn get_station_changes( &mut self, limit: u64, last_change_uuid: Option<String> ) -> Result<Vec<ApiStationHistory>, Box<dyn Error>>
pub async fn get_server_config(&mut self) -> Result<ApiConfig, Box<dyn Error>>
pub async fn get_server_status(&mut self) -> Result<ApiStatus, Box<dyn Error>>
sourcepub async fn station_click<P: AsRef<str>>(
&mut self,
stationuuid: P
) -> Result<ApiStationClickResult, Box<dyn Error>>
pub async fn station_click<P: AsRef<str>>( &mut self, stationuuid: P ) -> Result<ApiStationClickResult, Box<dyn Error>>
Add a click to a station found by stationuuid
sourcepub async fn station_vote<P: AsRef<str>>(
&mut self,
stationuuid: P
) -> Result<ApiStationVoteResult, Box<dyn Error>>
pub async fn station_vote<P: AsRef<str>>( &mut self, stationuuid: P ) -> Result<ApiStationVoteResult, Box<dyn Error>>
Add a vote to a station found by a stationuuid
pub fn get_stations(&self) -> StationSearchBuilder
pub fn get_countries(&self) -> CountrySearchBuilder
pub fn get_languages(&self) -> LanguageSearchBuilder
pub async fn send<P: AsRef<str>, Q: DeserializeOwned>( &mut self, endpoint: P, mapjson: HashMap<String, String> ) -> Result<Q, Box<dyn Error>>
pub async fn get_default_servers() -> Result<Vec<String>, Box<dyn Error>>
Trait Implementations§
source§impl Clone for RadioBrowserAPI
impl Clone for RadioBrowserAPI
source§fn clone(&self) -> RadioBrowserAPI
fn clone(&self) -> RadioBrowserAPI
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl RefUnwindSafe for RadioBrowserAPI
impl Send for RadioBrowserAPI
impl Sync for RadioBrowserAPI
impl Unpin for RadioBrowserAPI
impl UnwindSafe for RadioBrowserAPI
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more