syphon-core 0.1.1

Core Objective-C bindings for Syphon on macOS
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

//! Error types for Syphon

use std::fmt;

/// Result type alias for Syphon operations
pub type Result<T> = std::result::Result<T, SyphonError>;

/// Errors that can occur when using Syphon
#[derive(Debug, Clone)]
pub enum SyphonError {
    /// Syphon is not available on this platform
    NotAvailable,
    
    /// The Syphon framework could not be found
    FrameworkNotFound(String),
    
    /// Failed to create a server or client
    CreateFailed(String),
    
    /// Server with the given name was not found
    ServerNotFound(String),

    /// Multiple servers match the given name — use connect_by_info() with a UUID
    AmbiguousServerName(String),
    
    /// Invalid parameter was provided
    InvalidParameter(String),
    
    /// Failed to publish a frame
    PublishFailed(String),
    
    /// Failed to receive a frame
    ReceiveFailed(String),
    
    /// An Objective-C exception was thrown
    ObjcException,
    
    /// Failed to lock/unlock an IOSurface
    LockFailed,
    
    /// The received frame was invalid
    InvalidFrame,
    
    /// IOSurface operation failed
    IOSurfaceError(u32),
    
    /// Texture operation failed
    TextureError(String),
    
    /// Other error
    Other(String),
}

impl fmt::Display for SyphonError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SyphonError::NotAvailable => {
                write!(f, "Syphon is not available on this platform")
            }
            SyphonError::FrameworkNotFound(msg) => {
                write!(f, "Syphon framework not found: {}", msg)
            }
            SyphonError::CreateFailed(msg) => {
                write!(f, "Failed to create Syphon object: {}", msg)
            }
            SyphonError::ServerNotFound(name) => {
                write!(f, "Syphon server '{}' not found", name)
            }
            SyphonError::AmbiguousServerName(name) => {
                write!(f, "Multiple Syphon servers named '{}' — use connect_by_info() with a UUID for precise selection", name)
            }
            SyphonError::InvalidParameter(msg) => {
                write!(f, "Invalid parameter: {}", msg)
            }
            SyphonError::PublishFailed(msg) => {
                write!(f, "Failed to publish frame: {}", msg)
            }
            SyphonError::ReceiveFailed(msg) => {
                write!(f, "Failed to receive frame: {}", msg)
            }
            SyphonError::ObjcException => {
                write!(f, "Objective-C exception was thrown")
            }
            SyphonError::LockFailed => {
                write!(f, "Failed to lock/unlock IOSurface")
            }
            SyphonError::InvalidFrame => {
                write!(f, "Invalid frame received")
            }
            SyphonError::IOSurfaceError(code) => {
                write!(f, "IOSurface error: {}", code)
            }
            SyphonError::TextureError(msg) => {
                write!(f, "Texture error: {}", msg)
            }
            SyphonError::Other(msg) => {
                write!(f, "{}", msg)
            }
        }
    }
}

impl std::error::Error for SyphonError {}

impl From<std::ffi::NulError> for SyphonError {
    fn from(e: std::ffi::NulError) -> Self {
        SyphonError::InvalidParameter(format!("String contains null byte: {}", e))
    }
}

impl From<std::io::Error> for SyphonError {
    fn from(e: std::io::Error) -> Self {
        SyphonError::Other(format!("IO error: {}", e))
    }
}