fuchsia_inspect/writer/types/
string_property.rs

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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use crate::writer::{Inner, InnerPropertyType, InspectType, Property};
use log::error;
use std::borrow::Cow;

/// Inspect String Property data type.
///
/// NOTE: do not rely on PartialEq implementation for true comparison.
/// Instead leverage the reader.
///
/// NOTE: Operations on a Default value are no-ops.
#[derive(Debug, PartialEq, Eq, Default)]
pub struct StringProperty {
    inner: Inner<InnerPropertyType>,
}

impl<'t> Property<'t> for StringProperty {
    type Type = &'t str;

    fn set(&self, value: &'t str) {
        if let Some(ref inner_ref) = self.inner.inner_ref() {
            inner_ref
                .state
                .try_lock()
                .and_then(|mut state| {
                    state.set_string_property(inner_ref.block_index, Cow::Borrowed(value))
                })
                .unwrap_or_else(|e| error!("Failed to set property. Error: {:?}", e));
        }
    }
}

impl InspectType for StringProperty {}

crate::impl_inspect_type_internal!(StringProperty);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::writer::testing_utils::{get_state, GetBlockExt};
    use crate::writer::Node;
    use inspect_format::{BlockType, Buffer, PropertyFormat};

    impl StringProperty {
        fn load_data(&self) -> Option<String> {
            let mut data_index = None;
            self.get_block::<_, Buffer>(|b| data_index = Some(b.extent_index()));
            self.inner.inner_ref().and_then(|inner_ref| {
                inner_ref
                    .state
                    .try_lock()
                    .and_then(|state| state.load_string(data_index.unwrap()))
                    .ok()
            })
        }
    }

    #[fuchsia::test]
    fn basic_string_property() {
        // Create and use a default value.
        let default = StringProperty::default();
        default.set("test");

        let state = get_state(4096);
        let root = Node::new_root(state);
        let node = root.create_child("node");
        {
            let property = node.create_string("property", "test");
            property.get_block::<_, Buffer>(|property_block| {
                assert_eq!(property_block.block_type(), Some(BlockType::BufferValue));
                assert_eq!(property_block.total_length(), 0);
                assert_eq!(property_block.format(), Some(PropertyFormat::StringReference));
            });
            assert_eq!(property.load_data().unwrap(), "test");
            node.get_block::<_, inspect_format::Node>(|node_block| {
                assert_eq!(node_block.child_count(), 1);
            });

            property.set("test-set");
            property.get_block::<_, Buffer>(|property_block| {
                assert_eq!(property_block.total_length(), 0);
            });
            assert_eq!(property.load_data().unwrap(), "test-set");
        }
        node.get_block::<_, inspect_format::Node>(|node_block| {
            assert_eq!(node_block.child_count(), 0);
        });
    }

    #[fuchsia::test]
    fn string_property_interning() {
        // Create and use a default value.
        let default = StringProperty::default();
        default.set("test");

        let state = get_state(4096);
        let root = Node::new_root(state);
        let node = root.create_child("node");

        let property1 = node.create_string("property", "test");
        let mut name_idx_1 = None;
        let mut payload_idx_1 = None;
        property1.get_block::<_, Buffer>(|property_block| {
            name_idx_1 = Some(property_block.name_index());
            payload_idx_1 = Some(property_block.extent_index());
        });

        let property2 = node.create_string("test", "property");
        let mut name_idx_2 = None;
        let mut payload_idx_2 = None;
        property2.get_block::<_, Buffer>(|property_block| {
            name_idx_2 = Some(property_block.name_index());
            payload_idx_2 = Some(property_block.extent_index());
        });

        assert_eq!(property1.load_data().unwrap(), "test");
        assert_eq!(property2.load_data().unwrap(), "property");
        assert_eq!(name_idx_1, payload_idx_2);
        assert_eq!(name_idx_2, payload_idx_1);
    }
}