fswtch 0.1.7

Rust bindings and helpers for writing FreeSWITCH modules
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

use std::{ffi::CStr, marker::PhantomData, ptr::NonNull};

use crate::{cstring, sys};

pub struct XmlConfig {
    root: NonNull<sys::switch_xml>,
    settings: Option<NonNull<sys::switch_xml>>,
}

impl XmlConfig {
    pub fn open(file: impl AsRef<str>) -> Option<Self> {
        let file = cstring(file).ok()?;
        let mut settings = std::ptr::null_mut();
        // SAFETY: FreeSWITCH writes the configuration node into `settings` when the file is found.
        let root =
            unsafe { sys::switch_xml_open_cfg(file.as_ptr(), &mut settings, std::ptr::null_mut()) };
        let root = NonNull::new(root)?;

        Some(Self {
            root,
            settings: NonNull::new(settings),
        })
    }

    pub fn settings(&self) -> Option<XmlNode<'_>> {
        self.settings.map(XmlNode::new)
    }
}

impl Drop for XmlConfig {
    fn drop(&mut self) {
        // SAFETY: `root` was returned by FreeSWITCH XML APIs and is owned by this wrapper.
        unsafe {
            sys::switch_xml_free(self.root.as_ptr());
        }
    }
}

#[derive(Copy, Clone)]
pub struct XmlNode<'a> {
    raw: NonNull<sys::switch_xml>,
    _owner: PhantomData<&'a XmlConfig>,
}

impl<'a> XmlNode<'a> {
    fn new(raw: NonNull<sys::switch_xml>) -> Self {
        Self {
            raw,
            _owner: PhantomData,
        }
    }

    pub fn child(self, name: impl AsRef<str>) -> Option<Self> {
        let name = cstring(name).ok()?;
        // SAFETY: `self.raw` is live and `name` is valid for the duration of this call.
        let child = unsafe { sys::switch_xml_child(self.raw.as_ptr(), name.as_ptr()) };
        NonNull::new(child).map(Self::new)
    }

    pub fn next(self) -> Option<Self> {
        // SAFETY: `self.raw` is a live XML node for traversal.
        NonNull::new(unsafe { (*self.raw.as_ptr()).next }).map(Self::new)
    }

    pub fn attr(self, name: impl AsRef<str>) -> Option<String> {
        let name = cstring(name).ok()?;
        // SAFETY: `self.raw` is live and `name` is valid for the duration of this call.
        let value = unsafe { sys::switch_xml_attr(self.raw.as_ptr(), name.as_ptr()) };
        if value.is_null() {
            return None;
        }

        // SAFETY: FreeSWITCH returns a null-terminated attribute value when present.
        unsafe { CStr::from_ptr(value) }
            .to_str()
            .ok()
            .map(ToOwned::to_owned)
    }
}