fstapi 0.0.3

API for manipulating Fast Signal Trace (FST) format waveforms.
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

use crate::{Error, Result};
use std::ffi::{CStr, CString, c_char};
use std::path::Path;
use std::slice;

/// Trait for converting [`Path`] into string.
pub(crate) trait PathToStr<'a> {
  /// Converts to <code>&[str]</code>.
  fn to_str(&'a self) -> Result<&'a str>;
}

impl<'a, P> PathToStr<'a> for P
where
  P: AsRef<Path>,
{
  fn to_str(&'a self) -> Result<&'a str> {
    self.as_ref().to_str().ok_or(Error::InvalidUtf8Str(None))
  }
}

/// Trait for converting raw C string into string.
pub(crate) trait RawToStr {
  /// Converts to <code>&[str]</code>.
  unsafe fn to_str<'a>(self) -> Result<&'a str>;
}

impl RawToStr for *const c_char {
  unsafe fn to_str<'a>(self) -> Result<&'a str> {
    unsafe { CStr::from_ptr(self) }
      .to_str()
      .map_err(|e| Error::InvalidUtf8Str(Some(e)))
  }
}

impl RawToStr for (*const c_char, u32) {
  unsafe fn to_str<'a>(self) -> Result<&'a str> {
    let bytes = unsafe { slice::from_raw_parts(self.0 as *const u8, self.1 as usize) };
    CStr::from_bytes_with_nul(bytes)
      .map_err(Error::CStrConv)?
      .to_str()
      .map_err(|e| Error::InvalidUtf8Str(Some(e)))
  }
}

/// Trait for converting bytes into [`CString`].
pub(crate) trait IntoCString {
  /// Converts into [`CString`].
  fn into_cstring(self) -> Result<CString>;
}

impl<T> IntoCString for T
where
  T: Into<Vec<u8>>,
{
  fn into_cstring(self) -> Result<CString> {
    CString::new(self).map_err(Error::CStringConv)
  }
}

/// Trait for converting `Option<Handle>` into handle for C API.
pub(crate) trait IntoCHandle {
  /// Converts into C handle.
  fn into_handle(self) -> u32;
}