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
//! This crate is a Rust library for using the [Serde] serialization framework //! with data in [YAML] file format. //! //! This library does not reimplement a YAML parser; it uses [yaml-rust] which //! is a pure Rust YAML 1.2 implementation. //! //! [Serde]: https://github.com/serde-rs/serde //! [YAML]: http://yaml.org //! [yaml-rust]: https://github.com/chyh1990/yaml-rust //! //! # Examples //! //! ``` //! use std::collections::BTreeMap; //! //! fn main() -> Result<(), serde_yaml::Error> { //! // You have some type. //! let mut map = BTreeMap::new(); //! map.insert("x".to_string(), 1.0); //! map.insert("y".to_string(), 2.0); //! //! // Serialize it to a YAML string. //! let s = serde_yaml::to_string(&map)?; //! assert_eq!(s, "---\nx: 1.0\ny: 2.0"); //! //! // Deserialize it back to a Rust type. //! let deserialized_map: BTreeMap<String, f64> = serde_yaml::from_str(&s)?; //! assert_eq!(map, deserialized_map); //! Ok(()) //! } //! ``` //! //! ## Using Serde derive //! //! It can also be used with Serde's serialization code generator `serde_derive` to //! handle structs and enums defined in your own program. //! //! ``` //! # use serde_derive::{Serialize, Deserialize}; //! use serde::{Serialize, Deserialize}; //! //! #[derive(Debug, PartialEq, Serialize, Deserialize)] //! struct Point { //! x: f64, //! y: f64, //! } //! //! fn main() -> Result<(), serde_yaml::Error> { //! let point = Point { x: 1.0, y: 2.0 }; //! //! let s = serde_yaml::to_string(&point)?; //! assert_eq!(s, "---\nx: 1.0\ny: 2.0"); //! //! let deserialized_point: Point = serde_yaml::from_str(&s)?; //! assert_eq!(point, deserialized_point); //! Ok(()) //! } //! ``` #![doc(html_root_url = "https://docs.rs/serde_yaml/0.8.11")] #![deny(missing_docs)] #![allow(unknown_lints, bare_trait_objects)] #![cfg_attr(feature = "cargo-clippy", allow(renamed_and_removed_lints))] #![cfg_attr(feature = "cargo-clippy", deny(clippy, clippy_pedantic))] // Whitelisted clippy lints #![cfg_attr(feature = "cargo-clippy", allow(redundant_field_names))] // Whitelisted clippy_pedantic lints #![cfg_attr(feature = "cargo-clippy", allow( // private Deserializer::next should_implement_trait, // things are often more readable this way cast_lossless, module_name_repetitions, single_match_else, use_self, // code is acceptable cast_possible_wrap, cast_precision_loss, cast_sign_loss, // not practical indexing_slicing, missing_docs_in_private_items, // not stable checked_conversions, empty_enum, // meh, some things won't fail result_unwrap_used, ))] pub use crate::de::{from_reader, from_slice, from_str}; pub use crate::error::{Error, Location, Result}; pub use crate::mapping::Mapping; pub use crate::ser::{to_string, to_vec, to_writer}; pub use crate::value::{from_value, to_value, Index, Number, Sequence, Value}; /// Entry points for deserializing with pre-existing state. /// /// These functions are only exposed this way because we don't yet expose a /// Deserializer type. Data formats that have a public Deserializer should not /// copy these signatures. pub mod seed { pub use super::de::{from_reader_seed, from_slice_seed, from_str_seed}; } mod de; mod error; mod mapping; mod number; mod path; mod ser; mod value;