Compare commits

..

2 commits

Author SHA1 Message Date
askiiart
45679ec98a
docs: fix missing thing 2024-12-02 10:04:20 -06:00
askiiart
0a6ffe6755
fix SearchParameters fields being private 2024-12-02 10:02:46 -06:00
2 changed files with 9 additions and 9 deletions

View file

@ -126,21 +126,21 @@ pub struct SearchParameters {
/// What type of search this is /// What type of search this is
/// ///
/// Search types: `search`, `tv-search`, `movie-search`, `audio-search`, `book-search` /// Search types: `search`, `tv-search`, `movie-search`, `audio-search`, `book-search`
pub(crate) search_type: String, pub search_type: String,
/// The text query for the search /// The text query for the search
pub(crate) q: Option<String>, pub q: Option<String>,
/// The apikey, for authentication /// The apikey, for authentication
pub(crate) apikey: Option<String>, pub apikey: Option<String>,
/// A [`Vec`] containing the numeric category IDs to be included in the search results /// A [`Vec`] containing the numeric category IDs to be included in the search results
pub(crate) categories: Option<Vec<u32>>, pub categories: Option<Vec<u32>>,
/// A [`Vec`] containing the extended attribute names to be included in the search results /// A [`Vec`] containing the extended attribute names to be included in the search results
pub(crate) attributes: Option<Vec<String>>, pub attributes: Option<Vec<String>>,
/// Whether *all* extended attributes should be included in the search results; overrules `attributes` /// Whether *all* extended attributes should be included in the search results; overrules `attributes`
pub(crate) extended_attrs: Option<bool>, pub extended_attrs: Option<bool>,
/// How many items to skip/offset by in the results. /// How many items to skip/offset by in the results.
pub(crate) offset: Option<u32>, pub offset: Option<u32>,
/// The maximum number of items to return - also limited to whatever `limits` is in [`Caps`] /// The maximum number of items to return - also limited to whatever `limits` is in [`Caps`]
pub(crate) limit: u32, pub limit: u32,
} }
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]

View file

@ -1,6 +1,6 @@
//! Notes regarding the usage of torznab-tooolkit, and its implementation of Torznab //! Notes regarding the usage of torznab-tooolkit, and its implementation of Torznab
//! //!
//! - Please implement whatever attributes for torrents you can whenever possible to improve search results; particularly, `season`, `ep`, and `*id` fields are recommended, besides those listed in [``] //! - Please implement whatever attributes for torrents you can whenever possible to improve search results; particularly, `season`, `ep`, and `*id` fields are recommended, besides those listed in [`Torrent`]
//! - Potential attributes are listed [here](https://torznab.github.io/spec-1.3-draft/torznab/Specification-v1.3.html#predefined-attributes) //! - Potential attributes are listed [here](https://torznab.github.io/spec-1.3-draft/torznab/Specification-v1.3.html#predefined-attributes)
//! - Because the behavior of `length` is ambiguous, torznab-toolkit just sets it to 0; the size is just specified by the `size` attribute //! - Because the behavior of `length` is ambiguous, torznab-toolkit just sets it to 0; the size is just specified by the `size` attribute
//! - See [here](https://torznab.github.io/spec-1.3-draft/revisions/1.0-Torznab-Torrent-Support.html) for details //! - See [here](https://torznab.github.io/spec-1.3-draft/revisions/1.0-Torznab-Torrent-Support.html) for details