booru-rs 0.3.0

An async Booru client for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Generic types used across booru clients.

use std::fmt;

/// Sort order for post queries.
///
/// These are the common sort options available on most booru sites.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum Sort {
    /// Sort by post ID.
    Id,
    /// Sort by score/votes.
    Score,
    /// Sort by rating.
    Rating,
    /// Sort by uploader.
    User,
    /// Sort by image height.
    Height,
    /// Sort by image width.
    Width,
    /// Sort by source URL.
    Source,
    /// Sort by last update time.
    Updated,
    /// Random ordering.
    Random,
}

impl fmt::Display for Sort {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            Self::Id => "id",
            Self::Score => "score",
            Self::Rating => "rating",
            Self::User => "user",
            Self::Height => "height",
            Self::Width => "width",
            Self::Source => "source",
            Self::Updated => "updated",
            Self::Random => "random",
        };
        write!(f, "{s}")
    }
}

// =============================================================================
// Deprecated types for backwards compatibility
// =============================================================================

#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
use crate::model::danbooru::DanbooruRating;
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
use crate::model::gelbooru::GelbooruRating;
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
use crate::model::safebooru::SafebooruRating;

/// Wrapper enum for client-specific ratings.
///
/// # Deprecated
///
/// This enum is deprecated in favor of using the client's associated `Rating` type
/// directly. Each client now has compile-time type safety for its rating type.
///
/// ## Migration
///
/// Before (0.2.x):
/// ```ignore
/// DanbooruClient::builder()
///     .rating(DanbooruRating::General) // Used Rating enum internally
///     .build()
/// ```
///
/// After (0.3.x):
/// ```ignore
/// DanbooruClient::builder()
///     .rating(DanbooruRating::General) // Uses DanbooruRating directly
///     .build()
/// ```
#[deprecated(
    since = "0.3.0",
    note = "Use client-specific rating types directly (e.g., DanbooruRating). \
            The Rating wrapper is no longer needed due to compile-time type safety."
)]
#[derive(Debug, Clone)]
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
pub enum Rating {
    /// Danbooru-specific rating.
    Danbooru(DanbooruRating),
    /// Gelbooru-specific rating.
    Gelbooru(GelbooruRating),
    /// Safebooru-specific rating.
    Safebooru(SafebooruRating),
}

#[allow(deprecated)]
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
impl From<DanbooruRating> for Rating {
    fn from(value: DanbooruRating) -> Self {
        Rating::Danbooru(value)
    }
}

#[allow(deprecated)]
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
impl From<GelbooruRating> for Rating {
    fn from(value: GelbooruRating) -> Self {
        Rating::Gelbooru(value)
    }
}

#[allow(deprecated)]
#[cfg(all(feature = "danbooru", feature = "gelbooru", feature = "safebooru"))]
impl From<SafebooruRating> for Rating {
    fn from(value: SafebooruRating) -> Self {
        Rating::Safebooru(value)
    }
}