Struct DataStoreNode

pub struct DataStoreNode<'store> { /* private fields */ }

Element borrowed from the linked list of nodes that make up a DataStore.

Lifetime 'store

A DataStoreNode is borrowed from a DataStore, and cannot outlive the DataStore it was borrowed from:

let mut store = DataStore::new();
store.add_named_i64("value", 5);

let node = store.first_node().unwrap();

drop(store);

// Error: `node` cannot outlive `store`.
println!("node name: {:?}", node.name());

Implementations

impl<'store> DataStoreNode<'store>

pub fn name(&self) -> Option<String>

Get the name associated with this node, if any.

LibraryLink C Function: DataStoreNode_getName.

Examples found in repository

examples/tests/test_data_store.rs (line 148)

fn test_data_store_nodes() {
    {
        let mut data = DataStore::new();
        data.add_i64(5);

        assert_eq!(data.len(), 1);

        let node = data.first_node().expect("got first node");

        let ty: sys::type_t = node.data_type_raw();

        assert_eq!(ty, sys::MType_Integer as i32);
    }

    // Test DataStoreNode::name() method.
    {
        let mut data = DataStore::new();
        data.add_named_i64("hello", 5);

        assert_eq!(data.len(), 1);

        let node = data.first_node().expect("got first node");

        assert_eq!(node.data_type_raw(), sys::MType_Integer as i32);
        assert_eq!(node.name(), Some("hello".to_owned()))
    }

    // Test DataStore::nodes() method and Debug formatting of DataStoreNode.
    {
        let mut store = DataStore::new();

        store.add_i64(5);
        store.add_named_bool("condition", true);
        store.add_str("Hello, World!");

        let mut nodes = store.nodes();

        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: None, value: 5 }"#
        );
        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: Some("condition"), value: true }"#
        );
        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: None, value: "Hello, World!" }"#
        );
        assert!(nodes.next().is_none());
    }
}

pub fn value<'node>(&'node self) -> DataStoreNodeValue<'node>

Get the value stored in this DataStoreNode.

This is a safe wrapper around DataStoreNode::data_raw().

Examples found in repository

examples/data_store.rs (line 37)

fn string_join(store: DataStore) -> String {
    let mut buffer = String::new();

    for node in store.nodes() {
        // If `node.value()` is a string, append it to our string.
        // If `node.value()` is NOT a string, silently skip it.
        if let DataStoreNodeValue::Str(string) = node.value() {
            buffer.push_str(string);
        }
    }

    buffer
}

pub fn next_node(&self) -> Option<DataStoreNode<'store>>

Get the next node in this linked list of DataStoreNode’s.

LibraryLink C Function: DataStoreNode_getNextNode.

pub fn data_type_raw(&self) -> type_t

LibraryLink C Function: DataStoreNode_getDataType.

Examples found in repository

examples/tests/test_data_store.rs (line 133)

fn test_data_store_nodes() {
    {
        let mut data = DataStore::new();
        data.add_i64(5);

        assert_eq!(data.len(), 1);

        let node = data.first_node().expect("got first node");

        let ty: sys::type_t = node.data_type_raw();

        assert_eq!(ty, sys::MType_Integer as i32);
    }

    // Test DataStoreNode::name() method.
    {
        let mut data = DataStore::new();
        data.add_named_i64("hello", 5);

        assert_eq!(data.len(), 1);

        let node = data.first_node().expect("got first node");

        assert_eq!(node.data_type_raw(), sys::MType_Integer as i32);
        assert_eq!(node.name(), Some("hello".to_owned()))
    }

    // Test DataStore::nodes() method and Debug formatting of DataStoreNode.
    {
        let mut store = DataStore::new();

        store.add_i64(5);
        store.add_named_bool("condition", true);
        store.add_str("Hello, World!");

        let mut nodes = store.nodes();

        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: None, value: 5 }"#
        );
        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: Some("condition"), value: true }"#
        );
        assert_eq!(
            format!("{:?}", nodes.next().unwrap()),
            r#"DataStoreNode { name: None, value: "Hello, World!" }"#
        );
        assert!(nodes.next().is_none());
    }
}

pub unsafe fn data_raw(&self) -> &MArgument

LibraryLink C Function: DataStoreNode_getData.

pub unsafe fn try_data_raw<'node>( &'node self, ) -> Result<&'node MArgument, errcode_t>

LibraryLink C Function: DataStoreNode_getData.

Trait Implementations

impl<'store> Debug for DataStoreNode<'store>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.