pushers 1.5.0

A Rust client for interacting with the Pusher HTTP API
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

//! Pusher HTTP API client for Rust
//!
//! This library provides a safe, fast, and idiomatic Rust client for the Pusher HTTP API.
//!
//! # Features
//!
//! - `rustls-tls` (default): Use rustls for TLS (recommended for cross-compilation)
//! - `native-tls`: Use native TLS (OpenSSL on Linux, Secure Transport on macOS, SChannel on Windows)
//! - `encryption` (default): Enable support for end-to-end encrypted channels
//!
//! # Cross-Compilation
//!
//! This library is designed to work well with cross-compilation. The default features use
//! pure-Rust dependencies that compile easily to different targets.
//!
//! ```bash
//! # Cross-compile to ARM
//! cross build --target armv7-unknown-linux-gnueabihf --release
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]

pub mod auth;
pub mod channel;
pub mod config;
pub mod errors;
pub mod events;
pub mod pusher;
pub mod token;
pub mod util;
pub mod webhook;

#[macro_use]
extern crate zeroize;

pub use channel::{Channel, ChannelName, ChannelType};
pub use config::{Config, ConfigBuilder};
pub use errors::{PusherError, RequestError, WebhookError};
pub use pusher::Pusher;
pub use token::Token;
pub use webhook::{Webhook, WebhookEvent};

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

// Re-export commonly used types
pub use auth::{SocketAuth, UserAuth};
pub use events::{BatchEvent, Event, TriggerParams};

/// Check if encryption support is available at compile time
pub const ENCRYPTION_AVAILABLE: bool = cfg!(feature = "encryption");

/// Information about the build configuration
pub struct BuildInfo;

impl BuildInfo {
    /// Returns whether encryption support is available
    pub fn has_encryption() -> bool {
        ENCRYPTION_AVAILABLE
    }

    /// Returns the TLS backend being used
    pub fn tls_backend() -> &'static str {
        if cfg!(feature = "rustls-tls") {
            "rustls"
        } else if cfg!(feature = "native-tls") {
            "native-tls"
        } else {
            "none"
        }
    }

    /// Returns the encryption backend being used
    #[cfg(feature = "encryption")]
    pub fn encryption_backend() -> &'static str {
        if cfg!(feature = "sodiumoxide") {
            "sodiumoxide"
        } else {
            "chacha20poly1305"
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_build_info() {
        println!("Encryption available: {}", BuildInfo::has_encryption());
        println!("TLS backend: {}", BuildInfo::tls_backend());

        #[cfg(feature = "encryption")]
        println!("Encryption backend: {}", BuildInfo::encryption_backend());
    }
}