twilight_util/builder/embed/
footer.rs

1//! Create embed footers.
2
3use super::ImageSource;
4use twilight_model::channel::message::embed::EmbedFooter;
5
6/// Create an embed footer with a builder.
7///
8/// This can be passed into [`EmbedBuilder::footer`].
9///
10/// [`EmbedBuilder::footer`]: crate::builder::embed::EmbedBuilder::footer
11#[derive(Clone, Debug, Eq, PartialEq)]
12#[must_use = "must be built into an embed footer"]
13pub struct EmbedFooterBuilder(EmbedFooter);
14
15impl EmbedFooterBuilder {
16    /// Create a new embed footer builder.
17    ///
18    /// Refer to [`FOOTER_TEXT_LENGTH`] for the maximum number of UTF-16 code
19    /// points that can be in a footer's text.
20    ///
21    /// [`FOOTER_TEXT_LENGTH`]: twilight_validate::embed::FOOTER_TEXT_LENGTH
22    pub fn new(text: impl Into<String>) -> Self {
23        Self(EmbedFooter {
24            icon_url: None,
25            proxy_icon_url: None,
26            text: text.into(),
27        })
28    }
29
30    /// Build into an embed footer.
31    #[allow(clippy::missing_const_for_fn)]
32    #[must_use = "should be used as part of an embed builder"]
33    pub fn build(self) -> EmbedFooter {
34        self.0
35    }
36
37    /// Add a footer icon.
38    ///
39    /// # Examples
40    ///
41    /// Create a footer by Twilight with a URL to an image of its logo:
42    ///
43    /// ```
44    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
45    /// use twilight_util::builder::embed::{EmbedFooterBuilder, ImageSource};
46    ///
47    /// let icon_url =
48    ///     ImageSource::url("https://raw.githubusercontent.com/twilight-rs/twilight/main/logo.png")?;
49    /// let footer = EmbedFooterBuilder::new("Twilight")
50    ///     .icon_url(icon_url)
51    ///     .build();
52    /// # Ok(()) }
53    /// ```
54    pub fn icon_url(mut self, image_source: ImageSource) -> Self {
55        self.0.icon_url.replace(image_source.0);
56
57        self
58    }
59}
60
61impl From<EmbedFooterBuilder> for EmbedFooter {
62    /// Convert an embed footer builder into an embed footer.
63    ///
64    /// This is equivalent to calling [`EmbedFooterBuilder::build`].
65    fn from(builder: EmbedFooterBuilder) -> Self {
66        builder.build()
67    }
68}
69
70#[cfg(test)]
71mod tests {
72    use super::*;
73    use static_assertions::assert_impl_all;
74    use std::fmt::Debug;
75
76    assert_impl_all!(EmbedFooterBuilder: Clone, Debug, Eq, PartialEq, Send, Sync);
77    assert_impl_all!(EmbedFooter: From<EmbedFooterBuilder>);
78
79    #[test]
80    fn builder() {
81        let expected = EmbedFooter {
82            icon_url: Some("https://example.com/1.png".to_owned()),
83            proxy_icon_url: None,
84            text: "a footer".to_owned(),
85        };
86        let image = ImageSource::url("https://example.com/1.png").unwrap();
87        let actual = EmbedFooterBuilder::new("a footer").icon_url(image).build();
88        assert_eq!(actual, expected);
89    }
90}
twilight_util/builder/embed/footer.rs

twilight_util/builder/embed/
footer.rs
