Expand description
This crate provides an API on top of TinyTinyRSS
Usage
Add this to your Cargo.toml:
[dependencies]
ttrss_api = "0.0.1"Then add this to your crate:
extern crate ttrss_api;To use:
fn main() {
let apilevel: Option<ApiLevel> = match get_api_level().expect("Failed to get response").content {
Content::GetApiLevel(x) => { Some(x) },
_ => None,
};
println!("api level {:?}", apilevel.unwrap());Structs
Error response returned from API
API Level
Attachment
Categories
Config
Counter
Feed
Feed Tree
Feed Tree Category wraps metadata around lower level feed tree items
Feed Tree Item wraps represents the lowest level of item detail, although may contain child items
Guid structure with version and uid details, along with hash
Single Headline
Wraps some metadata around the headlines from get_headlines
Labels
Logged In
Login
Preference
TTRSS responses are wrapped around a seq and status, with the details per the API call within the content field. This object represents that wrapper.
Status
Unread
Version
Enums
Represents the various types of responese from the TTRSS API. The user is expected to inspect the enum for the appropriate type.
Used in getCounters
Guid
Used in update_article to describe which field to update
Used in update_article to describe the mode
used in get_headlines to filter describe how to filter headlines
Functions
Catchup feed.
Get API level.
Get article ID’s contents.
Get list of categories.
Get configruration.
Get counters.
Create tree of all feeds’ and related info.
Get list of feeds.
Get list of headlines.
Get all labels.
Return one preference value.
Get unread feeds.
Get API version.
Is the session ID logged in?
Login to TTRSS. This will automatically happen if the API call requires a session ID
Logout of the session.
Internal call to generalize communication to TTRSS’ API among multiple API calls
Set an article’s label.
Share information to published feed.
Subscribe to a feed.
Unsubscribe to a feed.
Update an article.
Update the feed.