mssf_core/
strings.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
// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation.  All rights reserved.
// Licensed under the MIT License (MIT). See License.txt in the repo root for license information.
// ------------------------------------------------------------

use crate::{WString, PCWSTR};
use mssf_com::FabricCommon::{IFabricStringResult, IFabricStringResult_Impl};
use windows_core::implement;

// Basic implementation of fabric string result
// usually used as string return value to fabric runtime.
#[derive(Debug)]
#[implement(IFabricStringResult)]
pub struct StringResult {
    data: WString,
}

// Recommend to use WStringWrap to construct this and convert to
// IFabricStringResult.
impl StringResult {
    pub fn new(data: WString) -> StringResult {
        StringResult { data }
    }
}

impl IFabricStringResult_Impl for StringResult_Impl {
    fn get_String(&self) -> crate::PCWSTR {
        // This is some hack to get the raw pointer out.
        crate::PCWSTR::from_raw(self.data.as_ptr())
    }
}

// If nullptr returns empty string.
// requires the PCWSTR points to a valid buffer with null terminatior
fn safe_pwstr_to_wstring(raw: PCWSTR) -> WString {
    if raw.is_null() {
        return WString::new();
    }
    WString::from_wide(unsafe { raw.as_wide() })
}

// Convert helper for WString and PCWSTR and IFabricStringResult
pub struct WStringWrap {
    h: WString,
}

impl WStringWrap {
    pub fn into_wstring(self) -> WString {
        self.h
    }
}

impl From<WString> for WStringWrap {
    fn from(value: WString) -> Self {
        Self { h: value }
    }
}

impl From<PCWSTR> for WStringWrap {
    fn from(value: PCWSTR) -> Self {
        let h = safe_pwstr_to_wstring(value);
        Self { h }
    }
}

impl From<WStringWrap> for WString {
    fn from(val: WStringWrap) -> Self {
        val.h
    }
}

impl From<&IFabricStringResult> for WStringWrap {
    fn from(value: &IFabricStringResult) -> Self {
        let content = unsafe { value.get_String() };
        let h = safe_pwstr_to_wstring(content);
        Self { h }
    }
}

impl From<WStringWrap> for IFabricStringResult {
    fn from(value: WStringWrap) -> Self {
        StringResult::new(value.h).into()
    }
}

// note that wstring must be valid for pcwstr lifetime
pub fn get_pcwstr_from_opt(opt: &Option<WString>) -> PCWSTR {
    match opt {
        Some(x) => PCWSTR(x.as_ptr()),
        None => PCWSTR::null(),
    }
}

#[cfg(test)]
mod test {
    use crate::strings::WStringWrap;

    use super::StringResult;
    use crate::WString;
    use mssf_com::FabricCommon::IFabricStringResult;

    #[test]
    fn test_str_addr() {
        // Test the addr returned to SF is right.
        let addr = "1.2.3.4:1234";

        // Check wstring len.
        let haddr = WString::from(addr);
        let haddr_slice = haddr.as_wide();
        assert_eq!(haddr_slice.len(), 12);

        // check StringResult len.
        let com_addr: IFabricStringResult = StringResult::new(haddr.clone()).into();
        let raw = unsafe { com_addr.get_String() };
        let slice = unsafe { raw.as_wide() };
        assert_eq!(slice.len(), 12);

        // check StringResult conversion is right
        let haddr2: WString = WStringWrap::from(&com_addr).into();
        assert_eq!(haddr, haddr2);
    }
}