fuchsia_inspect/writer/types/
property.rs

Help
1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::writer::private::InspectTypeInternal;
6use crate::writer::{Error, InnerType, State};
7use inspect_format::BlockIndex;
8
9/// Trait implemented by properties.
10pub trait Property<'t>: InspectTypeInternal {
11    /// The type of the property.
12    type Type;
13
14    /// Set the property value to |value|.
15    fn set(&self, value: Self::Type);
16
17    /// Takes a function to execute as under a single lock of the Inspect VMO. This function
18    /// receives a reference to the `Property` on which it is called.
19    fn atomic_update<R, F: FnOnce(&Self) -> R>(&self, update_fn: F) -> R {
20        self.atomic_access(update_fn)
21    }
22}
23
24/// Trait implemented by numeric properties providing common operations.
25pub trait NumericProperty<'t>: Property<'t> {
26    /// Add the given |value| to the property current value.
27    fn add(&self, value: <Self as Property<'t>>::Type) -> Option<<Self as Property<'t>>::Type>;
28
29    /// Subtract the given |value| from the property current value.
30    fn subtract(&self, value: <Self as Property<'t>>::Type)
31        -> Option<<Self as Property<'t>>::Type>;
32}
33
34/// Get the usable length of a type.
35pub trait Length {
36    fn len(&self) -> Option<usize>;
37    fn is_empty(&self) -> Option<bool> {
38        self.len().map(|s| s == 0)
39    }
40}
41
42impl<T: ArrayProperty + InspectTypeInternal> Length for T {
43    fn len(&self) -> Option<usize> {
44        if let Ok(state) = self.state()?.try_lock() {
45            return Some(state.get_array_size(self.block_index()?));
46        }
47        None
48    }
49}
50
51/// Trait implemented by all array properties providing common operations on arrays.
52pub trait ArrayProperty: Length + InspectTypeInternal {
53    /// The type of the array entries.
54    type Type<'a>
55    where
56        Self: 'a;
57
58    /// Sets the array value to `value` at the given `index`.
59    fn set<'a>(&self, index: usize, value: impl Into<Self::Type<'a>>)
60    where
61        Self: 'a;
62
63    /// Sets all slots of the array to 0 and releases any references.
64    fn clear(&self);
65
66    /// Takes a function to execute as under a single lock of the Inspect VMO. This function
67    /// receives a reference to the `ArrayProperty` on which it is called.
68    fn atomic_update<R, F: FnOnce(&Self) -> R>(&self, update_fn: F) -> R {
69        self.atomic_access(update_fn)
70    }
71}
72
73pub trait ArithmeticArrayProperty: ArrayProperty {
74    /// Adds the given `value` to the property current value at the given `index`.
75    fn add<'a>(&self, index: usize, value: Self::Type<'a>)
76    where
77        Self: 'a;
78
79    /// Subtracts the given `value` to the property current value at the given `index`.
80    fn subtract<'a>(&self, index: usize, value: Self::Type<'a>)
81    where
82        Self: 'a;
83}
84
85/// Trait implemented by all histogram properties providing common operations.
86pub trait HistogramProperty {
87    /// The type of each value added to the histogram.
88    type Type;
89
90    /// Inserts the given `value` in the histogram.
91    fn insert(&self, value: Self::Type);
92
93    /// Inserts the given `value` in the histogram `count` times.
94    fn insert_multiple(&self, value: Self::Type, count: usize);
95
96    /// Clears all buckets of the histogram.
97    fn clear(&self);
98}
99
100#[derive(Default, Debug)]
101pub(crate) struct InnerPropertyType;
102
103impl InnerType for InnerPropertyType {
104    type Data = ();
105    fn free(state: &State, _: &Self::Data, block_index: BlockIndex) -> Result<(), Error> {
106        let mut state_lock = state.try_lock()?;
107        state_lock
108            .free_string_or_bytes_buffer_property(block_index)
109            .map_err(|err| Error::free("property", block_index, err))
110    }
111}
fuchsia_inspect/writer/types/property.rs

fuchsia_inspect/writer/types/
property.rs
