22 releases (11 breaking)

Uses old Rust 2015

0.22.0 Jun 8, 2020
0.20.1 May 23, 2019
0.19.0 Mar 6, 2019
0.17.1 Dec 13, 2018
0.16.0 Oct 3, 2018

#2149 in Web programming

Download history 7/week @ 2024-01-08 8/week @ 2024-01-15 5/week @ 2024-02-05 12/week @ 2024-02-12 21/week @ 2024-02-19 78/week @ 2024-02-26 21/week @ 2024-03-04 45/week @ 2024-03-11 27/week @ 2024-03-18 15/week @ 2024-03-25 114/week @ 2024-04-01 15/week @ 2024-04-08 22/week @ 2024-04-15

170 downloads per month
Used in jokestodon

MIT/Apache and GPL-3.0 licenses

635KB
5K SLoC

Elefren

A Wrapper for the Mastodon API.

Build Status Build Status Coverage Status crates.io Docs MIT/APACHE-2.0

Documentation

A wrapper around the API for Mastodon

Installation

To add elefren to your project, add the following to the [dependencies] section of your Cargo.toml

elefren = "0.22"

Example

In your Cargo.toml, make sure you enable the toml feature:

[dependencies]
elefren = { version = "0.22", features = ["toml"] }
// src/main.rs
extern crate elefren;

use std::error::Error;

use elefren::prelude::*;
use elefren::helpers::toml; // requires `features = ["toml"]`
use elefren::helpers::cli;

fn main() -> Result<(), Box<dyn Error>> {
    let mastodon = if let Ok(data) = toml::from_file("mastodon-data.toml") {
        Mastodon::from(data)
    } else {
        register()?
    };

    let you = mastodon.verify_credentials()?;

    println!("{:#?}", you);

    Ok(())
}

fn register() -> Result<Mastodon, Box<dyn Error>> {
    let registration = Registration::new("https://mastodon.social")
                                    .client_name("elefren-examples")
                                    .build()?;
    let mastodon = cli::authenticate(registration)?;

    // Save app data for using on the next run.
    toml::to_file(&*mastodon, "mastodon-data.toml")?;

    Ok(mastodon)
}

It also supports the Streaming API:

use elefren::prelude::*;
use elefren::entities::event::Event;

use std::error::Error;

fn main() -> Result<(), Box<Error>> {
    let data = Data {
      base: "".into(),
      client_id: "".into(),
      client_secret: "".into(),
      redirect: "".into(),
      token: "".into(),
    };

    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 => { /* .. */ },
        }
    }
    Ok(())
}

Dependencies

~27–42MB
~837K SLoC