1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# Elefren
## A Wrapper for the Mastodon API.
[![CircleCI](https://circleci.com/gh/pwoolcoc/elefren.svg?style=svg)](https://circleci.com/gh/pwoolcoc/elefren)
[![Build Status](https://ci.appveyor.com/api/projects/status/qeigk3nmmps52wxv?svg=true)](https://ci.appveyor.com/project/pwoolcoc/elefren)
[![Coverage Status](https://coveralls.io/repos/github/pwoolcoc/elefren/badge.svg?branch=master&service=github)](https://coveralls.io/github/pwoolcoc/elefren?branch=master)
[![crates.io](https://img.shields.io/crates/v/elefren.svg)](https://crates.io/crates/elefren)
[![Docs](https://docs.rs/elefren/badge.svg)](https://docs.rs/elefren)
[![MIT/APACHE-2.0](https://img.shields.io/crates/l/elefren.svg)](https://crates.io/crates/elefren)
[Documentation](https://docs.rs/elefren/)
A wrapper around the [API](https://github.com/tootsuite/documentation/blob/master/docs/Using-the-API/API.md#tag) for [Mastodon](https://mastodon.social/)
## Installation
To add `elefren` to your project, add the following to the
`[dependencies]` section of your `Cargo.toml`
```toml
elefren = "0.19"
```
## Usage
To use this crate in your project, add this to your crate root (lib.rs, main.rs, etc):
```rust,ignore
extern crate elefren;
```
## Example
In your `Cargo.toml`, make sure you enable the `toml` feature:
```toml
[dependencies]
elefren = { version = "0.19", features = ["toml"] }
```
```rust,no_run
// 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<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<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](https://docs.joinmastodon.org/api/streaming):
```no_run
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(())
}
```
|