Struct MastodonClient

pub struct MastodonClient { /* private fields */ }

The main entry point for interacting with the Mastodon API.

Use MastodonClient::new to create a new instance, and with_token to authenticate.

Implementations

impl MastodonClient

pub fn new(instance_url: &str) -> Self

Creates a new MastodonClient for the given instance URL.

Example

use mastodon_api::MastodonClient;
let client = MastodonClient::new("https://mastodon.social");

pub fn with_token(self, token: &str) -> Self

Sets the access token for the client, enabling authenticated requests.

pub fn access_token(&self) -> Option<&str>

Returns the access token used by the client, if any.

pub fn base_url(&self) -> &str

Returns the base URL of the Mastodon instance.

pub fn http_client(&self) -> &Client

Returns a reference to the underlying HTTP client.

pub fn accounts(&self) -> AccountsHandler<'_>

Access account-related endpoints.

pub fn follow_requests(&self) -> FollowRequestsHandler<'_>

Access follow request-related endpoints.

pub fn announcements(&self) -> AnnouncementsHandler<'_>

Access server-wide announcements.

pub fn statuses(&self) -> StatusesHandler<'_>

Access status-related (posting) endpoints.

pub fn timelines(&self) -> TimelinesHandler<'_>

Access timeline-related endpoints (Home, Public, etc.).

pub fn apps(&self) -> AppsHandler<'_>

Access application registration and OAuth endpoints.

pub fn media(&self) -> MediaHandler<'_>

Access media upload and management endpoints.

pub fn filters(&self) -> FiltersHandler<'_>

Access content filter management endpoints.

pub fn tags(&self) -> TagsHandler<'_>

Access tag management endpoints (followed and featured tags).

pub fn markers(&self) -> MarkersHandler<'_>

Access reading position sync (markers).

pub fn reports(&self) -> ReportsHandler<'_>

Access reports made by the authenticated user.

pub fn endorsements(&self) -> EndorsementsHandler<'_>

Access accounts endorsed (pinned) by the authenticated user.

pub fn domain_blocks(&self) -> DomainBlocksHandler<'_>

Access domain blocks for the authenticated user.

pub fn preferences(&self) -> PreferencesHandler<'_>

Access user preferences.

pub fn push(&self) -> PushHandler<'_>

Access Web Push API subscriptions.

pub fn admin(&self) -> AdminHandler<'_>

Access administrative moderation and management endpoints.

pub fn lists(&self) -> ListsHandler<'_>

Access list management endpoints.

pub fn conversations(&self) -> ConversationsHandler<'_>

Access direct conversation (DM) endpoints.

pub fn notifications(&self) -> NotificationsHandler<'_>

Access notification management endpoints.

pub fn search(&self) -> SearchHandler<'_>

Access global search endpoints.

pub fn suggestions(&self) -> SuggestionsHandler<'_>

Access account suggestions for follow.

pub fn trends(&self) -> TrendsHandler<'_>

Access trending content endpoints.

pub fn emojis(&self) -> EmojisHandler<'_>

Access custom emoji endpoints.

pub fn instance(&self) -> InstanceHandler<'_>

Access instance metadata endpoints.

pub fn streaming(&self) -> StreamingClient

Create a new streaming client for real-time events.

Trait Implementations

impl Clone for MastodonClient

fn clone(&self) -> MastodonClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.