Holllo/gravatar-rs
Holllo
/
gravatar-rs
1
Fork 0
Code Releases 5 Activity

Add documentation warnings and forbid unsafe code.

This commit is contained in:
Bauke 2022-04-02 22:16:20 +02:00
parent 471656abc5
commit 7b010a655b
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
source/lib.rs
View File

@ -1,3 +1,6 @@
#![forbid(unsafe_code)]
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
//! # gravatar-rs //! # gravatar-rs
//! //!
//! This crate provides an API for creating [Gravatar image URLs], and by //! This crate provides an API for creating [Gravatar image URLs], and by
@ -25,11 +28,32 @@
/// A generator for Gravatar image URLs. /// A generator for Gravatar image URLs.
#[derive(Debug)] #[derive(Debug)]
pub struct Generator { pub struct Generator {
/// The base URL for images, defaults to `www.gravatar.com`.
pub base_url: String, pub base_url: String,
/// Which default image to use when there is no matching Gravatar, defaults
/// to `None`.
///
/// See the [Gravatar documentation] for all the possible ways to use it.
///
/// [Gravatar documentation]: https://gravatar.com/site/implement/images/#default-image
pub default_image: Option<String>, pub default_image: Option<String>,
/// Whether you always want the default image to be returned, defaults to
/// `false`.
pub force_default: bool, pub force_default: bool,
/// A custom size for images, defaults to `None`.
pub image_size: Option<i32>, pub image_size: Option<i32>,
/// Whether to include `.jpg` in the image URL, defaults to false.
pub include_file_extension: bool, pub include_file_extension: bool,
/// Which rating should be allowed, defaults to `None`.
///
/// See the [Gravatar documentation] for all the possible ratings.
///
/// [Gravatar documentation]: https://gravatar.com/site/implement/images/#rating
pub rating: Option<String>, pub rating: Option<String>,
} }