Trait news_flash::feed_api::FeedApi[−][src]

pub trait FeedApi: Send + Sync {
    fn features(&self) -> FeedApiResult<PluginCapabilities>;

    fn has_user_configured(&self) -> FeedApiResult<bool>;

    fn user_name(&self) -> Option<String>;

    fn get_login_data(&self) -> Option<LoginData>;

#[must_use]    fn is_logged_in<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<bool>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn login<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        data: LoginData, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn logout<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn initial_sync<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<SyncResult>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn sync<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        max_count: u32, 
        last_sync: DateTime<Utc>, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<SyncResult>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_article_read<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        articles: &'life1 [ArticleID], 
        read: Read, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_article_marked<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        articles: &'life1 [ArticleID], 
        marked: Marked, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_feed_read<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        feeds: &'life1 [FeedID], 
        last_sync: DateTime<Utc>, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_category_read<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        categories: &'life1 [CategoryID], 
        last_sync: DateTime<Utc>, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_tag_read<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        tags: &'life1 [TagID], 
        last_sync: DateTime<Utc>, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn set_all_read<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        last_sync: DateTime<Utc>, 
        client: &'life1 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn add_feed<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        url: &'life1 Url, 
        title: Option<String>, 
        category: Option<CategoryID>, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<(Feed, Option<Category>)>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn remove_feed<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        id: &'life1 FeedID, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn move_feed<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
        &'life0 self, 
        feed_id: &'life1 FeedID, 
        from: &'life2 CategoryID, 
        to: &'life3 CategoryID, 
        client: &'life4 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        'life4: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn rename_feed<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        feed_id: &'life1 FeedID, 
        new_title: &'life2 str, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<FeedID>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn add_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        title: &'life1 str, 
        parent: Option<&'life2 CategoryID>, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<CategoryID>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn remove_category<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        id: &'life1 CategoryID, 
        remove_children: bool, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn rename_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        id: &'life1 CategoryID, 
        new_title: &'life2 str, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<CategoryID>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn move_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        id: &'life1 CategoryID, 
        parent: &'life2 CategoryID, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn import_opml<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        opml: &'life1 str, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn add_tag<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        title: &'life1 str, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<TagID>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn remove_tag<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        id: &'life1 TagID, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn rename_tag<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        id: &'life1 TagID, 
        new_title: &'life2 str, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<TagID>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn tag_article<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        article_id: &'life1 ArticleID, 
        tag_id: &'life2 TagID, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn untag_article<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self, 
        article_id: &'life1 ArticleID, 
        tag_id: &'life2 TagID, 
        client: &'life3 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        'life3: 'async_trait,
        Self: 'async_trait;

#[must_use]    fn get_favicon<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        feed_id: &'life1 FeedID, 
        client: &'life2 Client
    ) -> Pin<Box<dyn Future<Output = FeedApiResult<FavIcon>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;
}

Required methods

fn features(&self) -> FeedApiResult<PluginCapabilities>[src]

fn has_user_configured(&self) -> FeedApiResult<bool>[src]

fn user_name(&self) -> Option<String>[src]

fn get_login_data(&self) -> Option<LoginData>[src]

#[must_use]fn is_logged_in<'life0, 'life1, 'async_trait>(
    &'life0 self,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn login<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    data: LoginData,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn logout<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn initial_sync<'life0, 'life1, 'async_trait>(
    &'life0 self,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<SyncResult>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn sync<'life0, 'life1, 'async_trait>(
    &'life0 self,
    max_count: u32,
    last_sync: DateTime<Utc>,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<SyncResult>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_article_read<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    articles: &'life1 [ArticleID],
    read: Read,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_article_marked<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    articles: &'life1 [ArticleID],
    marked: Marked,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_feed_read<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    feeds: &'life1 [FeedID],
    last_sync: DateTime<Utc>,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_category_read<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    categories: &'life1 [CategoryID],
    last_sync: DateTime<Utc>,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_tag_read<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    tags: &'life1 [TagID],
    last_sync: DateTime<Utc>,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn set_all_read<'life0, 'life1, 'async_trait>(
    &'life0 self,
    last_sync: DateTime<Utc>,
    client: &'life1 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn add_feed<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    url: &'life1 Url,
    title: Option<String>,
    category: Option<CategoryID>,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<(Feed, Option<Category>)>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn remove_feed<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 FeedID,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn move_feed<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
    &'life0 self,
    feed_id: &'life1 FeedID,
    from: &'life2 CategoryID,
    to: &'life3 CategoryID,
    client: &'life4 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn rename_feed<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    feed_id: &'life1 FeedID,
    new_title: &'life2 str,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<FeedID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn add_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    title: &'life1 str,
    parent: Option<&'life2 CategoryID>,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<CategoryID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn remove_category<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 CategoryID,
    remove_children: bool,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn rename_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    id: &'life1 CategoryID,
    new_title: &'life2 str,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<CategoryID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn move_category<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    id: &'life1 CategoryID,
    parent: &'life2 CategoryID,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn import_opml<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    opml: &'life1 str,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn add_tag<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    title: &'life1 str,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<TagID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn remove_tag<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 TagID,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn rename_tag<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    id: &'life1 TagID,
    new_title: &'life2 str,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<TagID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn tag_article<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    article_id: &'life1 ArticleID,
    tag_id: &'life2 TagID,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn untag_article<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    article_id: &'life1 ArticleID,
    tag_id: &'life2 TagID,
    client: &'life3 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, [src]

#[must_use]fn get_favicon<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    feed_id: &'life1 FeedID,
    client: &'life2 Client
) -> Pin<Box<dyn Future<Output = FeedApiResult<FavIcon>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

Loading content...

Implementors

Loading content...