Struct elefren::Mastodon

pub struct Mastodon<H: HttpSend = HttpSender> {
    pub data: Data,
    // some fields omitted
}

Your mastodon application client, handles all requests to and from Mastodon.

Fields

data: Data

Raw data about your mastodon instance.

Trait Implementations

impl<H: HttpSend> MastodonClient<H> for Mastodon<H>

type Stream = EventReader<BufReader<Response>>

Type that wraps streaming API streams

fn favourites(&self) -> Result<Page<Status, H>>

Equivalent to get /api/v1/favourites

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.favourites();

fn blocks(&self) -> Result<Page<Account, H>>

Equivalent to get /api/v1/blocks

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.blocks();

fn domain_blocks(&self) -> Result<Page<String, H>>

Equivalent to get /api/v1/domain_blocks

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.domain_blocks();

fn follow_requests(&self) -> Result<Page<Account, H>>

Equivalent to get /api/v1/follow_requests

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.follow_requests();

fn get_home_timeline(&self) -> Result<Page<Status, H>>

Equivalent to get /api/v1/timelines/home

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_home_timeline();

fn get_emojis(&self) -> Result<Page<Emoji, H>>

Equivalent to get /api/v1/custom_emojis

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_emojis();

fn mutes(&self) -> Result<Page<Account, H>>

Equivalent to get /api/v1/mutes

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.mutes();

fn notifications(&self) -> Result<Page<Notification, H>>

Equivalent to get /api/v1/notifications

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.notifications();

fn reports(&self) -> Result<Page<Report, H>>

Equivalent to get /api/v1/reports

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.reports();

fn search_accounts<'a>(
    &self,
    q: &'a str,
    limit: Option<u64>,
    following: bool
) -> Result<Page<Account, H>>

Equivalent to get /api/v1/accounts/search

Errors

If access_token is not set.

fn get_endorsements(&self) -> Result<Page<Account, H>>

Equivalent to get /api/v1/endorsements

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_endorsements();

fn followers(&self, id: &str) -> Result<Page<Account, H>>

Equivalent to get /api/v1/accounts/{}/followers

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.followers("some-id");

fn following(&self, id: &str) -> Result<Page<Account, H>>

Equivalent to get /api/v1/accounts/{}/following

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.following("some-id");

fn reblogged_by(&self, id: &str) -> Result<Page<Account, H>>

Equivalent to get /api/v1/statuses/{}/reblogged_by

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.reblogged_by("some-id");

fn favourited_by(&self, id: &str) -> Result<Page<Account, H>>

Equivalent to get /api/v1/statuses/{}/favourited_by

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.favourited_by("some-id");

fn unblock_domain(&self, domain: String) -> Result<Empty>

Equivalent to delete /api/v1/domain_blocks

Errors

If access_token is not set.

fn instance(&self) -> Result<Instance>

Equivalent to get /api/v1/instance

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.instance();

fn verify_credentials(&self) -> Result<Account>

Equivalent to get /api/v1/accounts/verify_credentials

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.verify_credentials();

fn report(
    &self,
    account_id: &str,
    status_ids: Vec<&str>,
    comment: String
) -> Result<Report>

Equivalent to post /api/v1/reports

Errors

If access_token is not set.

fn block_domain(&self, domain: String) -> Result<Empty>

Equivalent to post /api/v1/domain_blocks

Errors

If access_token is not set.

fn authorize_follow_request(&self, id: &str) -> Result<Empty>

Equivalent to post /api/v1/accounts/follow_requests/authorize

Errors

If access_token is not set.

fn reject_follow_request(&self, id: &str) -> Result<Empty>

Equivalent to post /api/v1/accounts/follow_requests/reject

Errors

If access_token is not set.

fn search<'a>(&self, q: &'a str, resolve: bool) -> Result<SearchResult>

Equivalent to get /api/v1/search

Errors

If access_token is not set.

fn get_public_timeline<'a>(&self, local: bool) -> Result<Vec<Status>>

Equivalent to get /api/v1/timelines/public

Errors

If access_token is not set.

fn follows(&self, uri: Cow<'static, str>) -> Result<Account>

Equivalent to post /api/v1/follows

Errors

If access_token is not set.

fn media(&self, file: Cow<'static, str>) -> Result<Attachment>

Equivalent to post /api/v1/media

Errors

If access_token is not set.

fn clear_notifications(&self) -> Result<Empty>

Equivalent to post /api/v1/notifications/clear

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.clear_notifications();

fn get_push_subscription(&self) -> Result<Subscription>

Equivalent to get /api/v1/push/subscription

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_push_subscription();

fn delete_push_subscription(&self) -> Result<Empty>

Equivalent to delete /api/v1/push/subscription

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.delete_push_subscription();

fn get_filters(&self) -> Result<Vec<Filter>>

Equivalent to get /api/v1/filters

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_filters();

fn get_follow_suggestions(&self) -> Result<Vec<Account>>

Equivalent to get /api/v1/suggestions

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_follow_suggestions();

fn search_v2<'a>(&self, q: &'a str, resolve: bool) -> Result<SearchResultV2>

Equivalent to get /api/v2/search

Errors

If access_token is not set.

fn get_account(&self, id: &str) -> Result<Account>

Equivalent to get /api/v1/accounts/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_account("42");

fn follow(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/follow

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.follow("42");

fn unfollow(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/unfollow

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unfollow("42");

fn block(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/block

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.block("42");

fn unblock(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/unblock

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unblock("42");

fn mute(&self, id: &str) -> Result<Relationship>

Equivalent to get /api/v1/accounts/{}/mute

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.mute("42");

fn unmute(&self, id: &str) -> Result<Relationship>

Equivalent to get /api/v1/accounts/{}/unmute

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unmute("42");

fn get_notification(&self, id: &str) -> Result<Notification>

Equivalent to get /api/v1/notifications/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_notification("42");

fn get_status(&self, id: &str) -> Result<Status>

Equivalent to get /api/v1/statuses/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_status("42");

fn get_context(&self, id: &str) -> Result<Context>

Equivalent to get /api/v1/statuses/{}/context

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_context("42");

fn get_card(&self, id: &str) -> Result<Card>

Equivalent to get /api/v1/statuses/{}/card

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_card("42");

fn reblog(&self, id: &str) -> Result<Status>

Equivalent to post /api/v1/statuses/{}/reblog

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.reblog("42");

fn unreblog(&self, id: &str) -> Result<Status>

Equivalent to post /api/v1/statuses/{}/unreblog

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unreblog("42");

fn favourite(&self, id: &str) -> Result<Status>

Equivalent to post /api/v1/statuses/{}/favourite

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.favourite("42");

fn unfavourite(&self, id: &str) -> Result<Status>

Equivalent to post /api/v1/statuses/{}/unfavourite

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unfavourite("42");

fn delete_status(&self, id: &str) -> Result<Empty>

Equivalent to delete /api/v1/statuses/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.delete_status("42");

fn get_filter(&self, id: &str) -> Result<Filter>

Equivalent to get /api/v1/filters/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.get_filter("42");

fn delete_filter(&self, id: &str) -> Result<Empty>

Equivalent to delete /api/v1/filters/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.delete_filter("42");

fn delete_from_suggestions(&self, id: &str) -> Result<Empty>

Equivalent to delete /api/v1/suggestions/{}

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.delete_from_suggestions("42");

fn endorse_user(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/pin

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.endorse_user("42");

fn unendorse_user(&self, id: &str) -> Result<Relationship>

Equivalent to post /api/v1/accounts/{}/unpin

Errors

If access_token is not set.

let client = Mastodon::from(data);
client.unendorse_user("42");

fn add_filter(&self, request: &mut AddFilterRequest) -> Result<Filter>

POST /api/v1/filters

fn update_filter(
    &self,
    id: &str,
    request: &mut AddFilterRequest
) -> Result<Filter>

PUT /api/v1/filters/:id

fn update_credentials(
    &self,
    builder: &mut UpdateCredsRequest
) -> Result<Account>

PATCH /api/v1/accounts/update_credentials

fn new_status(&self, status: NewStatus) -> Result<Status>

Post a new status to the account.

fn get_tagged_timeline(
    &self,
    hashtag: String,
    local: bool
) -> Result<Vec<Status>>

Get timeline filtered by a hashtag(eg. #coffee) either locally or federated.

fn statuses<'a, 'b: 'a, S>(
    &'b self,
    id: &'b str,
    request: S
) -> Result<Page<Status, H>> where
    S: Into<Option<StatusesRequest<'a>>>, 

Get statuses of a single account by id. Optionally only with pictures and or excluding replies.

Example

let client = Mastodon::from(data);
let statuses = client.statuses("user-id", None)?;

let client = Mastodon::from(data);
let mut request = StatusesRequest::new();
request.only_media();
let statuses = client.statuses("user-id", request)?;

fn relationships(&self, ids: &[&str]) -> Result<Page<Relationship, H>>

Returns the client account's relationship to a list of other accounts. Such as whether they follow them or vice versa.

fn add_push_subscription(
    &self,
    request: &AddPushRequest
) -> Result<Subscription>

Add a push notifications subscription

fn update_push_data(&self, request: &UpdatePushRequest) -> Result<Subscription>

Update the data portion of the push subscription associated with this access token

fn follows_me(&self) -> Result<Page<Account, H>>

Get all accounts that follow the authenticated user

fn followed_by_me(&self) -> Result<Page<Account, H>>

Get all accounts that the authenticated user follows

fn streaming_user(&self) -> Result<Self::Stream>

returns events that are relevant to the authorized user, i.e. home timeline & notifications

Example

use elefren::entities::event::Event;
let client = Mastodon::from(data);
for event in client.streaming_user()? {
    match event {
        Event::Update(ref status) => { /* .. */ },
        Event::Notification(ref notification) => { /* .. */ },
        Event::Delete(ref id) => { /* .. */ },
        Event::FiltersChanged => { /* .. */ },
    }
}

fn streaming_public(&self) -> Result<Self::Stream>

returns all public statuses

fn streaming_local(&self) -> Result<Self::Stream>

Returns all local statuses

fn streaming_public_hashtag(&self, hashtag: &str) -> Result<Self::Stream>

Returns all public statuses for a particular hashtag

fn streaming_local_hashtag(&self, hashtag: &str) -> Result<Self::Stream>

Returns all local statuses for a particular hashtag

fn streaming_list(&self, list_id: &str) -> Result<Self::Stream>

Returns statuses for a list

fn streaming_direct(&self) -> Result<Self::Stream>

Returns all direct messages

impl From<Data> for Mastodon<HttpSender>

fn from(data: Data) -> Mastodon<HttpSender>

Creates a mastodon instance from the data struct.

impl<H: Clone + HttpSend> Clone for Mastodon<H>

fn clone(&self) -> Mastodon<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + HttpSend> Debug for Mastodon<H>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<H: HttpSend> Deref for Mastodon<H>

type Target = Data

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.