summaryrefslogtreecommitdiffstats
path: root/third_party/rust/serde_with/src/lib.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/rust/serde_with/src/lib.rs
parentInitial commit. (diff)
downloadfirefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz
firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/serde_with/src/lib.rs')
-rw-r--r--third_party/rust/serde_with/src/lib.rs140
1 files changed, 140 insertions, 0 deletions
diff --git a/third_party/rust/serde_with/src/lib.rs b/third_party/rust/serde_with/src/lib.rs
new file mode 100644
index 0000000000..5856a0d339
--- /dev/null
+++ b/third_party/rust/serde_with/src/lib.rs
@@ -0,0 +1,140 @@
+#![deny(
+ missing_debug_implementations,
+ missing_copy_implementations,
+ missing_docs,
+ trivial_casts,
+ trivial_numeric_casts,
+ unused_extern_crates,
+ unused_import_braces,
+ unused_qualifications,
+ variant_size_differences
+)]
+#![cfg_attr(feature = "cargo-clippy", allow(renamed_and_removed_lints))]
+#![doc(html_root_url = "https://docs.rs/serde_with/1.4.0")]
+
+//! [![docs.rs badge](https://docs.rs/serde_with/badge.svg)](https://docs.rs/serde_with/)
+//! [![crates.io badge](https://img.shields.io/crates/v/serde_with.svg)](https://crates.io/crates/serde_with/)
+//! [![Build Status](https://travis-ci.org/jonasbb/serde_with.svg?branch=master)](https://travis-ci.org/jonasbb/serde_with)
+//! [![codecov](https://codecov.io/gh/jonasbb/serde_with/branch/master/graph/badge.svg)](https://codecov.io/gh/jonasbb/serde_with)
+//!
+//! ---
+//!
+//! This crate provides custom de/serialization helpers to use in combination with [serde's with-annotation][with-annotation].
+//!
+//! Serde tracks a wishlist of similar helpers at [serde#553].
+//!
+//! # Usage
+//!
+//! Add this to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies.serde_with]
+//! version = "1.4.0"
+//! features = [ "..." ]
+//! ```
+//!
+//! The crate is divided into different modules.
+//! They contain helpers for external crates and must be enabled with the correspondig feature.
+//!
+//! Annotate your struct or enum to enable the custom de/serializer.
+//!
+//! ```rust
+//! # extern crate serde;
+//! # extern crate serde_derive;
+//! # extern crate serde_with;
+//! # use serde_derive::{Deserialize, Serialize};
+//! #[derive(Deserialize, Serialize)]
+//! struct Foo {
+//! #[serde(with = "serde_with::rust::display_fromstr")]
+//! bar: u8,
+//! }
+//! # fn main() {}
+//! ```
+//!
+//! Most helpers implement both deserialize and serialize.
+//! If you do not want to derive both, you can simply derive only the necessary parts.
+//! If you want to mix different helpers, you can write your annotations like
+//!
+//! ```rust
+//! # extern crate serde;
+//! # extern crate serde_derive;
+//! # extern crate serde_with;
+//! # use serde_derive::{Deserialize, Serialize};
+//! # #[cfg(feature = "json")]
+//! #[derive(Deserialize, Serialize)]
+//! struct Foo {
+//! #[serde(
+//! deserialize_with = "serde_with::rust::display_fromstr::deserialize",
+//! serialize_with = "serde_with::json::nested::serialize"
+//! )]
+//! bar: u8,
+//! }
+//! # fn main() {}
+//! ```
+//!
+//! However, this will prohibit you from applying deserialize on the value returned by serializing a struct.
+//!
+//! # Attributes
+//!
+//! The crate comes with custom attributes, which futher extend how serde serialization can be customized.
+//! They are enabled by default, but can be disabled, by removing the default features from this crate.
+//!
+//! The `serde_with` crate re-exports all items from `serde_with_macros`.
+//! This means, if you want to use any proc_macros, import them like `use serde_with::skip_serializing_none`.
+//!
+//! [The documentation for the custom attributes can be found here.](serde_with_macros)
+//!
+//! [with-annotation]: https://serde.rs/field-attrs.html#serdewith--module
+//! [serde#553]: https://github.com/serde-rs/serde/issues/553
+
+#[cfg(feature = "chrono")]
+extern crate chrono as chrono_crate;
+#[doc(hidden)]
+pub extern crate serde;
+#[cfg(feature = "json")]
+extern crate serde_json;
+#[cfg(feature = "macros")]
+extern crate serde_with_macros;
+
+#[cfg(feature = "chrono")]
+pub mod chrono;
+mod duplicate_key_impls;
+mod flatten_maybe;
+#[cfg(feature = "json")]
+pub mod json;
+pub mod rust;
+#[doc(hidden)]
+pub mod with_prefix;
+
+// Re-Export all proc_macros, as these should be seen as part of the serde_with crate
+#[cfg(feature = "macros")]
+#[doc(inline)]
+pub use serde_with_macros::*;
+
+/// Separator for string-based collection de/serialization
+pub trait Separator {
+ /// Return the string delimiting two elements in the string-based collection
+ fn separator() -> &'static str;
+}
+
+/// Predefined separator using a single space
+#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
+pub struct SpaceSeparator;
+
+impl Separator for SpaceSeparator {
+ #[inline]
+ fn separator() -> &'static str {
+ " "
+ }
+}
+
+/// Predefined separator using a single comma
+#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
+pub struct CommaSeparator;
+
+impl Separator for CommaSeparator {
+ #[inline]
+ fn separator() -> &'static str {
+ ","
+ }
+}