rsbadges 1.1.0

Create code badges from the comfort and safety of 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

// Copyright (c) 2021 RSBadges Authors, All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
// 3. Neither the name of the copyright holder nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
// OF SUCH DAMAGE.

use super::badge_type::*;
use super::generate_layout;
use super::generate_svg;

/// A badge container used to format and generate a badge SVG.
///
/// As the [Badge] struct holds generic badge data, the Style enum instructs how to
/// generate that data into a badge SVG. There are currently five Styles: `Plastic`,
/// `Flat`, `FlatSquare`, `ForTheBadge`, and `Social`. This naming follows the convention set by
/// [Shields.io](http://shields.io).
///
/// Once a Style object has been instantiated, a badge can be created using the
/// `generate_svg` function.
///
/// # Examples
///
/// ```
/// use rsbadges::{Badge, Style};
/// let badge = Badge {
///     label_text: String::from("Custom_label"),
///     msg_text: String::from("Custom_msg"),
///     ..Badge::default()
/// };
/// // Create a plastic badge using the data created above.
/// let badge_style = Style::Plastic(badge);
/// let badge_svg = badge_style.generate_svg();
/// // Save this to file with rsbadges::save_svg
/// ```
///
#[derive(Debug)]
pub enum Style {
    /// The "plastic" badge style
    Plastic(Badge),
    /// The "flat" badge style
    Flat(Badge),
    /// The "flat square" badge style
    FlatSquare(Badge),
    /// The "for the badge" badge style
    ForTheBadge(Badge),
    /// The "social" badge style
    Social(Badge),
}

impl Style {
    /// Generates an SVG from the badge data in the chosen badge style.
    ///
    /// Badges are lazily evaluated; that is, the data in the Badge struct
    /// is not verified until a badge is generated using this function.
    ///
    /// # Errors
    ///
    /// Since this is where data verification takes place, a number of errors are
    /// possible:
    ///
    /// - [ColorNotValid](BadgeError::ColorNotValid)
    /// - [CannotEmbedLogo](BadgeError::CannotEmbedLogo)
    /// - [CannotLocateFont](BadgeError::CannotLocateFont)
    /// - [CannotLoadFont](BadgeError::CannotLoadFont)
    ///
    /// See [BadgeError] for a full description of each.
    ///
    pub fn generate_svg(&self) -> Result<String, BadgeError> {
        let layout = match self {
            Style::Flat(badge) => generate_layout::flat_or_square(badge)?,
            Style::FlatSquare(badge) => generate_layout::flat_or_square(badge)?,
            Style::Plastic(badge) => generate_layout::plastic(badge)?,
            Style::ForTheBadge(badge) => generate_layout::for_the_badge(badge)?,
            Style::Social(badge) => generate_layout::social(badge)?,
        };

        let style = match self {
            Style::Flat(badge) => generate_svg::flat_svg(badge, layout)?,
            Style::FlatSquare(badge) => generate_svg::flat_square_svg(badge, layout)?,
            Style::Plastic(badge) => generate_svg::plastic_svg(badge, layout)?,
            Style::ForTheBadge(badge) => generate_svg::for_the_badge_svg(badge, layout)?,
            Style::Social(badge) => generate_svg::social_svg(badge, layout)?,
        };

        Ok(style)
    }
}