conjure-object 5.17.0

Runtime support for generated Conjure objects
Documentation 
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

// Copyright 2026 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Type-level marking of values as safe to log.
//!
//! Enable the `log-safety` cargo feature to opt in.

/// Marker trait for types whose serialized representation is safe to include
/// in logs and error parameters.
pub trait LogSafe {}

/// Wrapper struct for known-safe data.
///
/// WARNING: This is an escape hatch which allows the developer (YOU) to log unsafe data.
/// Misuse at your own risk.
#[derive(serde::Serialize)]
pub struct AssertLogSafe<T>(pub T);
impl<T> LogSafe for AssertLogSafe<T> {}

/// Marker bound that resolves to `LogSafe` when `log-safety` is enabled,
/// or is satisfied by any type when it's not.
#[cfg(feature = "log-safety")]
pub trait MaybeLogSafe: LogSafe {}

#[cfg(feature = "log-safety")]
impl<T: LogSafe> MaybeLogSafe for T {}

/// Marker bound that resolves to `LogSafe` when `log-safety` is enabled,
/// or is satisfied by any type when it's not.
#[cfg(not(feature = "log-safety"))]
pub trait MaybeLogSafe {}

#[cfg(not(feature = "log-safety"))]
impl<T> MaybeLogSafe for T {}

// conjure-object types that are safe
impl LogSafe for crate::Uuid {}

// containers
impl<T: LogSafe + ?Sized> LogSafe for &T {}
impl<T: LogSafe + ?Sized> LogSafe for &mut T {}
impl<T: LogSafe + ?Sized> LogSafe for Box<T> {}
impl<T: LogSafe + ?Sized> LogSafe for std::rc::Rc<T> {}
impl<T: LogSafe + ?Sized> LogSafe for std::sync::Arc<T> {}
impl<T: LogSafe> LogSafe for Option<T> {}
impl<T: LogSafe> LogSafe for Vec<T> {}
impl<T: LogSafe> LogSafe for std::collections::VecDeque<T> {}
impl<T: LogSafe> LogSafe for std::collections::LinkedList<T> {}
impl<T: LogSafe> LogSafe for [T] {}
impl<T: LogSafe, const N: usize> LogSafe for [T; N] {}
impl<K: LogSafe, V: LogSafe> LogSafe for std::collections::BTreeMap<K, V> {}
impl<K: LogSafe, V: LogSafe, S> LogSafe for std::collections::HashMap<K, V, S> {}
impl<T: LogSafe> LogSafe for std::collections::BTreeSet<T> {}
impl<T: LogSafe, S> LogSafe for std::collections::HashSet<T, S> {}
impl<T: LogSafe> LogSafe for std::collections::BinaryHeap<T> {}

/// Re-exports LogSafe derive macro
pub mod derive {
    pub use conjure_macros::LogSafe;
}