creator_plist/
lib.rs

1//! # Plist
2//!
3//! A rusty plist parser.
4//!
5//! ## Usage
6//!
7//! Put this in your `Cargo.toml`:
8//!
9//! ```toml
10//! [dependencies]
11//! plist = "1"
12//! ```
13//!
14//! And put this in your crate root:
15//!
16//! ```rust
17//! extern crate plist;
18//! ```
19//!
20//! ## Examples
21//!
22//! ### Using `serde`
23//!
24//! ```rust
25//! extern crate plist;
26//! # #[cfg(feature = "serde")]
27//! #[macro_use]
28//! extern crate serde_derive;
29//!
30//! # #[cfg(feature = "serde")]
31//! # fn main() {
32//! #[derive(Deserialize)]
33//! #[serde(rename_all = "PascalCase")]
34//! struct Book {
35//!     title: String,
36//!     author: String,
37//!     excerpt: String,
38//!     copies_sold: u64,
39//! }
40//!
41//! let book: Book = plist::from_file("tests/data/book.plist")
42//!     .expect("failed to read book.plist");
43//!
44//! assert_eq!(book.title, "Great Expectations");
45//! # }
46//! #
47//! # #[cfg(not(feature = "serde"))]
48//! # fn main() {}
49//! ```
50//!
51//! ### Using `Value`
52//!
53//! ```rust
54//! use plist::Value;
55//!
56//! let book = Value::from_file("tests/data/book.plist")
57//!     .expect("failed to read book.plist");
58//!
59//! let title = book
60//!     .as_dictionary()
61//!     .and_then(|dict| dict.get("Title"))
62//!     .and_then(|title| title.as_string());
63//!
64//! assert_eq!(title, Some("Great Expectations"));
65//! ```
66//!
67//! ## Unstable Features
68//!
69//! Many features from previous versions are now hidden behind the
70//! `enable_unstable_features_that_may_break_with_minor_version_bumps` feature. These will break in
71//! minor version releases after the 1.0 release. If you really really must use them you should
72//! specify a tilde requirement e.g. `plist = "~1.0.3"` in you `Cargo.toml` so that the plist crate
73//! is not automatically updated to version 1.1.
74
75pub mod dictionary;
76
77#[cfg(feature = "enable_unstable_features_that_may_break_with_minor_version_bumps")]
78pub mod stream;
79#[cfg(not(feature = "enable_unstable_features_that_may_break_with_minor_version_bumps"))]
80mod stream;
81
82mod date;
83mod error;
84mod integer;
85mod uid;
86mod value;
87
88pub use date::Date;
89pub use dictionary::Dictionary;
90pub use error::Error;
91pub use integer::Integer;
92pub use uid::Uid;
93pub use value::Value;
94
95// Optional serde module
96#[cfg(feature = "serde")]
97#[macro_use]
98extern crate serde;
99#[cfg(feature = "serde")]
100mod de;
101#[cfg(feature = "serde")]
102mod ser;
103#[cfg(all(
104    feature = "serde",
105    any(
106        test,
107        feature = "enable_unstable_features_that_may_break_with_minor_version_bumps"
108    )
109))]
110pub use self::{de::Deserializer, ser::Serializer};
111#[cfg(feature = "serde")]
112pub use self::{
113    de::{from_bytes, from_file, from_reader, from_reader_xml},
114    ser::{to_file_binary, to_file_xml, to_writer_binary, to_writer_xml},
115};
116
117#[cfg(all(test, feature = "serde"))]
118#[macro_use]
119extern crate serde_derive;
120
121#[cfg(all(test, feature = "serde"))]
122mod serde_tests;
123
124fn u64_to_usize(len_u64: u64) -> Option<usize> {
125    let len = len_u64 as usize;
126    if len as u64 != len_u64 {
127        return None; // Too long
128    }
129    Some(len)
130}
creator_plist/lib.rs

creator_plist/
lib.rs
