fieldmasker 0.0.1

A utility for selecting and filtering response fields via field masks.
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

//! Schema description and the [`MaskSpec`] trait.
//!
//! The serializer needs a structural **schema** to validate and apply field masks safely.
//! Provide that schema by implementing [`MaskSpec`] for your types, typically via the
//! `derive` feature, or (discouraged) manually using the [`Node`] builder APIs.

mod impls;
mod node;

/// Provides a static schema for a type used by field masking.
///
/// Implementations should return a `'static` reference to a schema [`Node`]. Most users
/// should rely on the `derive` feature to generate this automatically.
///
/// # Contract
/// * The schema must reflect the shape of the serialized form.
/// * The returned reference must live for the duration of the program.
///
/// # See also
/// - [`Node`] for constructing schemas manually.
pub trait MaskSpec {
    /// Returns the static schema node describing `Self`.
    fn mask_spec() -> &'static Node;
}

pub(crate) use node::Kind;
pub use node::Node;