Struct wallabag_api::types::EntriesFilter

pub struct EntriesFilter {
    pub archive: Option<bool>,
    pub starred: Option<bool>,
    pub sort: SortBy,
    pub order: SortOrder,
    pub tags: Vec<String>,
    pub since: i64,
    pub public: Option<bool>,
    pub per_page: Option<u32>,
}

Represents possible filters to apply to get_entries_filtered. To use the default for a filter, set the value to None.

Fields

archive: Option<bool>

None = all entries; true/false filters by archived or not archived only

starred: Option<bool>

None = all entries; true/false filters by starred or not starred only

sort: SortBy

Criteria to sort by.

order: SortOrder

Sort order.

tags: Vec<String>

Return entries that match all tags given. If vec empty, then no filtering is done. (currently not method to get only untagged entries)

Warning: do not supply tags with a comma in the name. TODO: make tags with comma in name impossible (how?)

since: i64

timestamp (in seconds) since when you want entries updated. This would be useful when implementing a sync method. Default is 0 (ie entries from the beginning of epoch).

public: Option<bool>

None = all entries; true/false = entries which do or do not have a public link

per_page: Option<u32>

Set to None to accept server default (usually 30); otherwise set to number of items per paginated page to request. Only need to change this if makes things more efficient for your use case (will make a difference to number of requests made and size of responses). Will result in a 404 error if set to 0.

Trait Implementations

impl Clone for EntriesFilter

fn clone(&self) -> EntriesFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntriesFilter

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

Formats the value using the given formatter.

impl Default for EntriesFilter

Use this to get an instance of EntriesFilter ready to go. The defaults here reflect the defaults that the server uses if the entries aren't specified.

fn default() -> Self

Returns the "default value" for a type.

impl Serialize for EntriesFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.