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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
#![forbid(unsafe_code, missing_debug_implementations, missing_docs)]
#![cfg_attr(test, deny(warnings))]
//! ## Example
//! ```rust
//! extern crate webmanifest;
//! extern crate failure;
//!
//! use webmanifest::{Manifest, Related};
//!
//! fn main() -> Result<(), failure::Error> {
//! let name = "My Cool Application";
//! let url = "https://play.google.com/store/apps/details?id=cheeaun.hackerweb";
//! let manifest = Manifest::builder(name)
//! .short_name("my app")
//! .bg_color("#000")
//! .related(&Related::new("play", url))
//! .build()?;
//! Ok(())
//! }
//! ```
extern crate failure;
extern crate mime_guess;
extern crate serde;
extern crate serde_json;
#[macro_use]
extern crate serde_derive;
use failure::Error;
mod direction;
mod display_mode;
mod icon;
mod orientation;
mod related;
pub use direction::Direction;
pub use display_mode::DisplayMode;
pub use icon::Icon;
pub use orientation::Orientation;
pub use related::Related;
/// The MIME type for `.webmanifest` files.
pub const MIME_TYPE_STR: &str = "application/manifest+json";
/// Create a new manifest builder.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Manifest<'s, 'i, 'r> {
name: &'s str,
#[serde(skip_serializing_if = "Option::is_none")]
short_name: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
start_url: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "display")]
display_mode: Option<DisplayMode>,
#[serde(skip_serializing_if = "Option::is_none")]
background_color: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
description: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "dir")]
direction: Option<Direction>,
#[serde(skip_serializing_if = "Option::is_none")]
orientation: Option<Orientation>,
#[serde(skip_serializing_if = "Option::is_none")]
lang: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
scope: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
theme_color: Option<&'s str>,
#[serde(skip_serializing_if = "Option::is_none")]
prefer_related_applications: Option<bool>,
#[serde(borrow)]
icons: Vec<Icon<'i>>,
#[serde(borrow)]
related_applications: Vec<Related<'r>>,
}
impl<'s, 'i, 'r> Manifest<'s, 'i, 'r> {
/// Create a new instance.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # use webmanifest::Manifest;
/// let name = "My Cool Application";
/// let builder = Manifest::builder(name);
/// ```
#[must_use]
#[inline]
pub fn builder(name: &'s str) -> Self {
Self {
name,
short_name: None,
description: None,
start_url: None,
display_mode: None,
orientation: None,
direction: None,
lang: None,
background_color: None,
theme_color: None,
scope: None,
prefer_related_applications: None,
icons: vec![],
related_applications: vec![],
}
}
/// Finalize the builder and create the manifest.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name).build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn build(self) -> Result<String, Error> {
let manifest = serde_json::to_string(&self)?;
Ok(manifest)
}
/// Finalize the builder and create a pretty representation of the manifest.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name).pretty()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn pretty(self) -> Result<String, Error> {
let manifest = serde_json::to_string_pretty(&self)?;
Ok(manifest)
}
/// Set the `short_name` value.
///
/// ## Panics
/// This will panic if the short name exceeds 12 characters.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .short_name("Cool App")
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn short_name(mut self, name: &'s str) -> Self {
debug_assert!(name.len() <= 12);
self.short_name = Some(name);
self
}
/// Set the `start_url` value.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .start_url(".")
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn start_url(mut self, url: &'s str) -> Self {
self.start_url = Some(url);
self
}
/// Set the `display` value.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, DisplayMode};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .display_mode(DisplayMode::Standalone)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn display_mode(mut self, mode: DisplayMode) -> Self {
self.display_mode = Some(mode);
self
}
/// Set the `background_color` value.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .bg_color("#000")
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn bg_color(mut self, color: &'s str) -> Self {
self.background_color = Some(color);
self
}
/// Set the `theme_color` value.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .theme_color("#000")
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn theme_color(mut self, color: &'s str) -> Self {
self.theme_color = Some(color);
self
}
/// Set the `description` value.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let desc = "It does many things.";
/// let manifest = Manifest::builder(name)
/// .description(desc)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn description(mut self, desc: &'s str) -> Self {
self.description = Some(desc);
self
}
/// Set the `lang` value.
///
/// Specifies the primary language for the values in the name and short_name
/// members. This value is a string containing a single language tag.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::Manifest;
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let lang = "en-US";
/// let manifest = Manifest::builder(name)
/// .lang(lang)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn lang(mut self, lang: &'s str) -> Self {
self.lang = Some(lang);
self
}
/// Set the `orientation` value.
///
/// Specifies a boolean value that hints for the user agent to indicate to the
/// user that the specified native applications are recommended over the
/// website. This should only be used if the related native apps really do
/// offer something that the website can't.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Orientation};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .orientation(Orientation::Portrait)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn orientation(mut self, orientation: Orientation) -> Self {
self.orientation = Some(orientation);
self
}
/// Set the `dir` value.
///
/// Specifies the primary text direction for the name, short_name, and
/// description members. Together with the lang member, it helps the correct
/// display of right-to-left languages.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Direction};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let lang = "en-US";
/// let manifest = Manifest::builder(name)
/// .direction(Direction::Ltr)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn direction(mut self, dir: Direction) -> Self {
self.direction = Some(dir);
self
}
/// Set the `prefer_related_applications` value.
///
/// Specifies a boolean value that hints for the user agent to indicate to the
/// user that the specified native applications are recommended over the
/// website. This should only be used if the related native apps really do
/// offer something that the website can't.
///
/// ## Note
/// If omitted, the value defaults to `false`.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Direction};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .prefer_related_applications(true)
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn prefer_related_applications(mut self, prefer: bool) -> Self {
self.prefer_related_applications = Some(prefer);
self
}
/// Set the `scope` value.
///
/// Defines the navigation scope of this website's context. This restricts
/// what web pages can be viewed while the manifest is applied. If the user
/// navigates outside the scope, it returns to a normal web page inside a
/// browser tab/window.
///
/// If the scope is a relative URL, the base URL will be the URL of the
/// manifest.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Direction};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let manifest = Manifest::builder(name)
/// .scope("/myapp/")
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn scope(mut self, scope: &'s str) -> Self {
self.scope = Some(scope);
self
}
/// Add an `Icon` to the icons vector.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Icon};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let src = "images/touch/homescreen48.png";
/// let manifest = Manifest::builder(name)
/// .icon(&Icon::new(&src, "48x48"))
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn icon(mut self, icon: &'i Icon) -> Self {
self.icons.push(icon.clone());
self
}
/// Add an `Related` application to the `related_applications` vector.
///
/// ## Example
/// ```rust
/// # extern crate webmanifest;
/// # extern crate failure;
/// # use webmanifest::{Manifest, Related};
/// # fn main() -> Result<(), failure::Error> {
/// let name = "My Cool Application";
/// let url = "https://play.google.com/store/apps/details?id=cheeaun.hackerweb";
/// let manifest = Manifest::builder(name)
/// .related(&Related::new("play", url))
/// .build()?;
/// # Ok(())}
/// ```
#[must_use]
#[inline]
pub fn related(mut self, related: &'r Related) -> Self {
self.related_applications.push(related.clone());
self
}
}