Struct instapaper::Client

pub struct Client {
    pub consumer_key: String,
    pub consumer_secret: String,
    pub oauth_key: Option<String>,
    pub oauth_secret: Option<String>,
}

The client instance to perform actions on. The consumer_key and consumer_secret are obtained through Instapaper's API documentation. The oauth_key and oauth_secret are obtained with the user's username, password, consumer_key, and consumer_secret by calling authenticate() on a Client.

Fields

consumer_key: String

consumer_secret: String

oauth_key: Option<String>

oauth_secret: Option<String>

Methods

impl Client

pub fn verify(&self) -> Result<User>

Verifies credentials, mostly used for testing.

pub fn archive(&self, bookmark_id: i64) -> Result<Bookmark>

Move a Bookmark to the archive folder.

pub fn bookmarks_in(&self, folder: &str) -> Result<List>

List all bookmarks and highlights in a folder. You'll need to obtain the folder id through either the API or the URL on Instapaper. unread and archive work as strings.

pub fn bookmarks(&self) -> Result<List>

List all bookmarks and highlights in the unread folder.

pub fn add(&self, url: &str, title: &str, description: &str) -> Result<Bookmark>

Add a bookmark. Pass a blank title and description if you want Instapaper's default.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Client

fn default() -> Client

Returns the "default value" for a type.

impl Debug for Client

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

Formats the value using the given formatter.