pub struct ListsHandler<'a> { /* private fields */ }Expand description
Handler for list-related API endpoints.
Implementations§
Source§impl<'a> ListsHandler<'a>
impl<'a> ListsHandler<'a>
Sourcepub fn new(client: &'a MastodonClient) -> Self
pub fn new(client: &'a MastodonClient) -> Self
Creates a new ListsHandler for the given client.
Parameters:
client: The client to use for making requests.
Returns:
ListsHandler: The created lists handler.
Sourcepub async fn list(&self) -> Result<Vec<List>>
pub async fn list(&self) -> Result<Vec<List>>
Fetches all lists for the authenticated user.
Returns:
Result<Vec<List>>: The fetched lists.
Corresponds to GET /api/v1/lists.
Sourcepub async fn get(&self, id: &str) -> Result<List>
pub async fn get(&self, id: &str) -> Result<List>
Fetches a specific list by its ID.
Parameters:
id: The ID of the list to fetch.
Returns:
Result<List>: The fetched list.
Corresponds to GET /api/v1/lists/:id.
Sourcepub async fn create(&self, title: &str) -> Result<List>
pub async fn create(&self, title: &str) -> Result<List>
Creates a new list with the given title.
Parameters:
title: The title of the list to create.
Returns:
Result<List>: The created list.
Corresponds to POST /api/v1/lists.
Sourcepub async fn delete(&self, id: &str) -> Result<()>
pub async fn delete(&self, id: &str) -> Result<()>
Deletes a list by its ID.
Parameters:
id: The ID of the list to delete.
Returns:
Result<()>: The deleted list.
Corresponds to DELETE /api/v1/lists/:id.
Sourcepub async fn add_accounts(
&self,
list_id: &str,
account_ids: &[String],
) -> Result<()>
pub async fn add_accounts( &self, list_id: &str, account_ids: &[String], ) -> Result<()>
Adds accounts to a list.
Parameters:
list_id: The ID of the list to add accounts to.account_ids: The IDs of the accounts to add to the list.
Returns:
Result<()>: The added accounts.
Corresponds to POST /api/v1/lists/:id/accounts.
Sourcepub async fn remove_accounts(
&self,
list_id: &str,
account_ids: &[String],
) -> Result<()>
pub async fn remove_accounts( &self, list_id: &str, account_ids: &[String], ) -> Result<()>
Removes accounts from a list.
Parameters:
list_id: The ID of the list to remove accounts from.account_ids: The IDs of the accounts to remove from the list.
Returns:
Result<()>: The removed accounts.
Corresponds to DELETE /api/v1/lists/:id/accounts.
Auto Trait Implementations§
impl<'a> Freeze for ListsHandler<'a>
impl<'a> !RefUnwindSafe for ListsHandler<'a>
impl<'a> Send for ListsHandler<'a>
impl<'a> Sync for ListsHandler<'a>
impl<'a> Unpin for ListsHandler<'a>
impl<'a> !UnwindSafe for ListsHandler<'a>
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