musli/context/
mod.rs

1//! [`Context`] implementations.
2//!
3//! [`Context`]: crate::Context
4
5mod access;
6use self::access::{Access, Shared};
7
8mod error_marker;
9#[doc(inline)]
10pub use self::error_marker::ErrorMarker;
11
12mod default_context;
13#[doc(inline)]
14pub use self::default_context::{DefaultContext, Error};
15
16mod context_error;
17#[doc(inline)]
18pub use self::context_error::ContextError;
19
20mod same;
21#[doc(inline)]
22pub use self::same::Same;
23
24mod capture;
25#[doc(inline)]
26pub use self::capture::Capture;
27
28mod ignore;
29#[doc(inline)]
30pub use self::ignore::Ignore;
31
32use crate::alloc::Allocator;
33#[cfg(feature = "alloc")]
34use crate::alloc::System;
35
36/// Construct a new default context using the provided allocator.
37///
38/// # Examples
39///
40/// ```
41/// use musli::context;
42///
43/// musli::alloc::default!(|alloc| {
44///     let cx = context::with_alloc(alloc);
45///     let encoding = musli::json::Encoding::new();
46///     let string = encoding.to_string_with(&cx, &42)?;
47///     assert_eq!(string, "42");
48/// });
49/// # Ok::<(), musli::context::ErrorMarker>(())
50/// ```
51pub fn with_alloc<'a, A, M>(alloc: &'a A) -> DefaultContext<'a, A, M>
52where
53    A: 'a + ?Sized + Allocator,
54    M: 'static,
55{
56    DefaultContext::with_alloc(alloc)
57}
58
59/// Construct a new default context using the static [`System`] allocator.
60///
61/// [`System`]: crate::alloc::System
62///
63/// # Examples
64///
65/// ```
66/// use musli::context;
67///
68/// musli::alloc::default!(|alloc| {
69///     let cx = context::new();
70///     let encoding = musli::json::Encoding::new();
71///     let string = encoding.to_string_with(&cx, &42)?;
72///     assert_eq!(string, "42");
73/// });
74/// # Ok::<(), musli::context::ErrorMarker>(())
75/// ```
76#[cfg(feature = "alloc")]
77#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
78pub fn new<M>() -> DefaultContext<'static, System, M>
79where
80    M: 'static,
81{
82    DefaultContext::new()
83}