kozabrada123/chorus
kozabrada123
/
chorus
mirror of https://github.com/polyphony-chat/chorus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change returns, add documentation

This commit is contained in:
Flori Weber 2023-06-18 15:39:52 +02:00
parent 5d6aab7d36
commit 9b52ceab4b
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/api/users/relationships.rs
View File

@ -16,11 +16,11 @@ impl UserMeta {
/// * `user_id` - A string slice that holds the ID of the user to retrieve the mutual relationships with. /// * `user_id` - A string slice that holds the ID of the user to retrieve the mutual relationships with.
/// ///
/// # Returns /// # Returns
/// This function returns a [`Option<Vec<Result<PublicUser, ChorusLibError>>>`]. /// This function returns a [`Result<Vec<PublicUser>, ChorusLibError>`].
pub async fn get_mutual_relationships( pub async fn get_mutual_relationships(
&mut self, &mut self,
user_id: &str, user_id: &str,
) -> Result<Option<Vec<types::PublicUser>>, ChorusLibError> { ) -> Result<Vec<types::PublicUser>, ChorusLibError> {
let belongs_to = self.belongs_to.borrow(); let belongs_to = self.belongs_to.borrow();
let url = format!( let url = format!(
"{}/users/{}/relationships/", "{}/users/{}/relationships/",
@ -29,7 +29,7 @@ impl UserMeta {
); );
drop(belongs_to); drop(belongs_to);
let request = Client::new().get(url).bearer_auth(self.token()); let request = Client::new().get(url).bearer_auth(self.token());
deserialize_response::<Option<Vec<types::PublicUser>>>( deserialize_response::<Vec<types::PublicUser>>(
request, request,
self, self,
crate::api::limits::LimitType::Global, crate::api::limits::LimitType::Global,
@ -37,6 +37,10 @@ impl UserMeta {
.await .await
} }
/// Retrieves the authenticated user's relationships.
///
/// # Returns
/// This function returns a [`Result<Vec<types::Relationship>, ChorusLibError>`].
pub async fn get_relationships(&mut self) -> Result<Vec<types::Relationship>, ChorusLibError> { pub async fn get_relationships(&mut self) -> Result<Vec<types::Relationship>, ChorusLibError> {
let belongs_to = self.belongs_to.borrow(); let belongs_to = self.belongs_to.borrow();
let url = format!("{}/users/@me/relationships/", belongs_to.urls.get_api(),); let url = format!("{}/users/@me/relationships/", belongs_to.urls.get_api(),);