fuchsia_inspect/writer/types/
string_property.rs

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::{Inner, InnerPropertyType, InspectType, Property};
6use log::error;
7use std::borrow::Cow;
8
9/// Inspect String Property data type.
10///
11/// NOTE: do not rely on PartialEq implementation for true comparison.
12/// Instead leverage the reader.
13///
14/// NOTE: Operations on a Default value are no-ops.
15#[derive(Debug, PartialEq, Eq, Default)]
16pub struct StringProperty {
17    inner: Inner<InnerPropertyType>,
18}
19
20impl<'t> Property<'t> for StringProperty {
21    type Type = &'t str;
22
23    fn set(&self, value: &'t str) {
24        if let Some(ref inner_ref) = self.inner.inner_ref() {
25            inner_ref
26                .state
27                .try_lock()
28                .and_then(|mut state| {
29                    state.set_string_property(inner_ref.block_index, Cow::Borrowed(value))
30                })
31                .unwrap_or_else(|e| error!("Failed to set property. Error: {:?}", e));
32        }
33    }
34}
35
36impl InspectType for StringProperty {
37    fn into_recorded(self) -> crate::writer::types::RecordedInspectType {
38        crate::writer::types::RecordedInspectType::StringProperty(self)
39    }
40}
41
42crate::impl_inspect_type_internal!(StringProperty);
43
44#[cfg(test)]
45mod tests {
46    use super::*;
47    use crate::writer::Node;
48    use crate::writer::testing_utils::{GetBlockExt, get_state};
49    use inspect_format::{BlockType, Buffer, PropertyFormat};
50
51    impl StringProperty {
52        fn load_data(&self) -> Option<String> {
53            let mut data_index = None;
54            self.get_block::<_, Buffer>(|b| data_index = Some(b.extent_index()));
55            self.inner.inner_ref().and_then(|inner_ref| {
56                inner_ref
57                    .state
58                    .try_lock()
59                    .and_then(|state| state.load_string(data_index.unwrap()))
60                    .ok()
61            })
62        }
63    }
64
65    #[fuchsia::test]
66    fn basic_string_property() {
67        // Create and use a default value.
68        let default = StringProperty::default();
69        default.set("test");
70
71        let state = get_state(4096);
72        let root = Node::new_root(state);
73        let node = root.create_child("node");
74        {
75            let property = node.create_string("property", "test");
76            property.get_block::<_, Buffer>(|property_block| {
77                assert_eq!(property_block.block_type(), Some(BlockType::BufferValue));
78                assert_eq!(property_block.total_length(), 0);
79                assert_eq!(property_block.format(), Some(PropertyFormat::StringReference));
80            });
81            assert_eq!(property.load_data().unwrap(), "test");
82            node.get_block::<_, inspect_format::Node>(|node_block| {
83                assert_eq!(node_block.child_count(), 1);
84            });
85
86            property.set("test-set");
87            property.get_block::<_, Buffer>(|property_block| {
88                assert_eq!(property_block.total_length(), 0);
89            });
90            assert_eq!(property.load_data().unwrap(), "test-set");
91        }
92        node.get_block::<_, inspect_format::Node>(|node_block| {
93            assert_eq!(node_block.child_count(), 0);
94        });
95    }
96
97    #[fuchsia::test]
98    fn string_property_interning() {
99        // Create and use a default value.
100        let default = StringProperty::default();
101        default.set("test");
102
103        let state = get_state(4096);
104        let root = Node::new_root(state);
105        let node = root.create_child("node");
106
107        let property1 = node.create_string("property", "test");
108        let mut name_idx_1 = None;
109        let mut payload_idx_1 = None;
110        property1.get_block::<_, Buffer>(|property_block| {
111            name_idx_1 = Some(property_block.name_index());
112            payload_idx_1 = Some(property_block.extent_index());
113        });
114
115        let property2 = node.create_string("test", "property");
116        let mut name_idx_2 = None;
117        let mut payload_idx_2 = None;
118        property2.get_block::<_, Buffer>(|property_block| {
119            name_idx_2 = Some(property_block.name_index());
120            payload_idx_2 = Some(property_block.extent_index());
121        });
122
123        assert_eq!(property1.load_data().unwrap(), "test");
124        assert_eq!(property2.load_data().unwrap(), "property");
125        assert_eq!(name_idx_1, payload_idx_2);
126        assert_eq!(name_idx_2, payload_idx_1);
127    }
128}
fuchsia_inspect/writer/types/string_property.rs

fuchsia_inspect/writer/types/
string_property.rs
