musli_common/
lib.rs

1//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/musli-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/musli)
2//! [<img alt="crates.io" src="https://img.shields.io/crates/v/musli-common.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/musli-common)
3//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-musli--common-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/musli-common)
4//!
5//! Common utilities shared by [Müsli] encodings.
6//!
7//! The [Reader] and [Writer] traits are defined in here which determined the
8//! types that can be used in collaboration with [Müsli].
9//!
10//! Please refer to <https://docs.rs/musli> for documentation.
11//!
12//! [Müsli]: <https://docs.rs/musli>
13//! [Reader]: https://docs.rs/musli-common/latest/musli-common/reader/trait.Reader.html
14//! [Writer]: https://docs.rs/musli-common/latest/musli-common/writer/trait.Writer.html
15
16#![deny(missing_docs)]
17#![no_std]
18#![cfg_attr(doc_cfg, feature(doc_cfg))]
19
20#[cfg_attr(test, macro_use)]
21#[cfg(feature = "std")]
22extern crate std;
23
24#[cfg(feature = "alloc")]
25extern crate alloc;
26
27pub(crate) mod context;
28pub(crate) mod fixed;
29#[macro_use]
30pub(crate) mod options;
31pub(crate) mod buf;
32pub(crate) mod reader;
33pub(crate) mod wrap;
34pub(crate) mod writer;
35
36#[doc(hidden)]
37pub mod exports {
38    pub mod context {
39        //! Helper types to set up a basic Müsli [`Context`].
40        //!
41        //! [`Context`]: musli::Context
42
43        #[doc(inline)]
44        pub use crate::context::*;
45    }
46
47    pub mod fixed {
48        //! A container which can store up to a fixed number of uninitialized bytes on
49        //! the stack and read into and from it.
50
51        #[doc(inline)]
52        pub use crate::fixed::FixedBytes;
53    }
54
55    pub mod options {
56        //! Serialization options.
57
58        #[doc(inline)]
59        pub use crate::options::*;
60    }
61
62    pub mod buf {
63        //! Utilitioes for working with buffers.
64
65        #[doc(inline)]
66        pub use crate::buf::*;
67    }
68
69    pub mod reader {
70        //! Trait for governing how a particular source of bytes is read.
71        //!
72        //! `musli` requires all sources to reference the complete data being read from
73        //! it which allows it to make the assumption the bytes are always returned with
74        //! the `'de` lifetime.
75
76        #[doc(inline)]
77        pub use crate::reader::*;
78    }
79
80    pub mod wrap {
81        //! Helpers for integrating musli with I/O types like [std::io] and
82        //! [std::io::Write].
83        //!
84        //! The central function in this module is the [wrap] function which constructs
85        //! an adapter around an I/O type to work with musli.
86
87        #[doc(inline)]
88        pub use crate::wrap::*;
89    }
90
91    pub mod writer {
92        //! Trait for governing how a particular sink of bytes is written to.
93        //!
94        //! To adapt [std::io::Write] types, see the [wrap][crate::wrap::wrap] function.
95
96        #[doc(inline)]
97        pub use crate::writer::*;
98    }
99
100    #[doc(inline)]
101    pub use musli_allocator as allocator;
102}
103
104#[doc(hidden)]
105pub mod buffered_writer;
106
107#[doc(hidden)]
108pub mod int;
109
110#[doc(hidden)]
111pub mod str;
112
113#[macro_use]
114mod macros;
115
116#[cfg_attr(feature = "std", path = "system/std.rs")]
117#[cfg_attr(not(feature = "std"), path = "system/no_std.rs")]
118mod system;
musli_common/lib.rs

musli_common/
lib.rs
