rstango 0.3.0

Implementation of the Tango distributed control system
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
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

//! Code for parsing and serializing device or global property values.
//! 
//! The parsing code is specific because a property value is only represented as an
//! array of strings in Tango.

use std::borrow::Cow;

use crate::error::{Result, Error, ErrorKind};
use crate::value::Spectrum;


/// A trait for converting some type into property'd values.
pub trait IntoProp<'d> {
    /// Push this property value into the given arrays of string values, this should not
    /// alter the property value itself.
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>>;
}

/// A trait for parsing a type from some property'd values.
pub trait FromProp: Sized {
    /// Parse this property'd type from a series of string values.
    fn from_prop(values: &Spectrum<str>) -> Result<Self>;
}

// =========================== //
//   Default implementations   //
// =========================== //

macro_rules! impl_prop_for_parse {
    ( $ty:ty ) => {
        
        impl<'d> IntoProp<'d> for $ty {
            #[inline]
            fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
                Some(Cow::<str>::Owned(format!("{self}")))
            }
        }
        
        impl<'d> IntoProp<'d> for &'_ $ty {
            #[inline]
            fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
                (*self).into_prop()
            }
        }
        
        impl FromProp for $ty {
            fn from_prop(values: &Spectrum<str>) -> Result<Self> {
                match values.len() {
                    0 => Err(Error::new(ErrorKind::InvalidProp)
                        .with_description(concat!("No value in the property, could not convert it to ", stringify!($ty)))),
                    1 => values.iter().next().expect("one value").parse::<$ty>()
                        .map_err(|e| Error::new(ErrorKind::InvalidProp)
                            .with_description(concat!("Failed to parse property value to ", stringify!($ty)))
                            .with_source(Box::new(e))),
                    2.. => Err(Error::new(ErrorKind::InvalidProp)
                        .with_description(concat!("More than one value in the property, could not convert it to ", stringify!($ty)))),
                }
            }
        }
        
        impl FromProp for Vec<$ty> {
            fn from_prop(values: &Spectrum<str>) -> Result<Self> {
                let mut ret = Vec::with_capacity(values.len());
                for val in values.iter() {
                    ret.push(val.parse::<$ty>()
                        .map_err(|e| Error::new(ErrorKind::InvalidProp)
                            .with_description(concat!("Failed to parse property value to ", stringify!($ty)))
                            .with_source(Box::new(e)))?);
                }
                Ok(ret)
            }
        }

    };
}

impl_prop_for_parse!(bool);
impl_prop_for_parse!(u8);
impl_prop_for_parse!(i8);
impl_prop_for_parse!(u16);
impl_prop_for_parse!(i16);
impl_prop_for_parse!(u32);
impl_prop_for_parse!(i32);
impl_prop_for_parse!(u64);
impl_prop_for_parse!(i64);
impl_prop_for_parse!(f32);
impl_prop_for_parse!(f64);

// =========================== //
//   String implementations    //
// =========================== //

impl<'d> IntoProp<'d> for Cow<'d, str> {
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
        Some(self)
    }
}

impl<'d> IntoProp<'d> for &'d str {
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
        Cow::<str>::Borrowed(self).into_prop()
    }
}

impl<'d> IntoProp<'d> for String {
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
        Cow::<str>::Owned(self).into_prop()
    }
}

impl<'d> IntoProp<'d> for Vec<String> {
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
        self.into_iter().map(Cow::Owned)
    }
}

impl<'d> IntoProp<'d> for &'d String {
    fn into_prop(self) -> impl IntoIterator<Item = Cow<'d, str>> {
        Cow::<str>::Borrowed(self).into_prop()
    }
}

impl FromProp for String {
    fn from_prop(values: &Spectrum<str>) -> Result<Self> {
        let mut buf = String::new();
        for val in values.iter() {
            if !buf.is_empty() {
                buf.push('\n');
            }
            buf.push_str(val);
        }
        Ok(buf)
    }
}

impl FromProp for Vec<String> {
    fn from_prop(values: &Spectrum<str>) -> Result<Self> {
        Ok(values.iter().map(str::to_string).collect())
    }
}

/// The values as they are, sharing the listing they are a slice of.
impl FromProp for Spectrum<str> {
    fn from_prop(values: &Spectrum<str>) -> Result<Self> {
        Ok(values.clone())
    }
}