pubnub 0.7.0

PubNub SDK for Rust
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
97
98
99
100
101
102

use crate::lib::alloc::{
    string::{String, ToString},
    vec::Vec,
};
use percent_encoding::{percent_encode, AsciiSet, CONTROLS};

/// https://url.spec.whatwg.org/#fragment-percent-encode-set
const FRAGMENT: &AsciiSet = &CONTROLS.add(b' ').add(b'"').add(b'<').add(b'>').add(b'`');

/// https://url.spec.whatwg.org/#path-percent-encode-set
const PATH: &AsciiSet = &FRAGMENT.add(b'#').add(b'?').add(b'{').add(b'}');

/// https://url.spec.whatwg.org/#userinfo-percent-encode-set
const USERINFO: &AsciiSet = &PATH
    .add(b'/')
    .add(b':')
    .add(b';')
    .add(b'=')
    .add(b'@')
    .add(b'[')
    .add(b'\\')
    .add(b']')
    .add(b'^')
    .add(b'|');

/// `+` sign needed by PubNub API
const PUBNUB_SET: &AsciiSet = &USERINFO.add(b'+').add(b'%').add(b'!').add(b'$');

/// Additional non-channel path component extension.
const PUBNUB_NON_CHANNEL_PATH: &AsciiSet = &PUBNUB_SET.add(b',');

pub enum UrlEncodeExtension {
    /// Default PubNub required encoding.
    Default,

    /// Encoding applied to any non-channel component in path.
    NonChannelPath,
}

/// `percent_encoding` crate recommends you to create your own set for encoding.
/// To be consistent in the whole codebase - we created a function that can be
/// used for encoding related stuff.
pub fn url_encode(data: &[u8]) -> String {
    url_encode_extended(data, UrlEncodeExtension::Default).to_string()
}

/// `percent_encoding` crate recommends you to create your own set for encoding.
/// To be consistent in the whole codebase - we created a function that can be
/// used for encoding related stuff.
pub fn url_encode_extended(data: &[u8], extension: UrlEncodeExtension) -> String {
    let set = match extension {
        UrlEncodeExtension::Default => PUBNUB_SET,
        UrlEncodeExtension::NonChannelPath => PUBNUB_NON_CHANNEL_PATH,
    };

    percent_encode(data, set).to_string()
}

/// Join list of encoded strings.
pub fn join_url_encoded(strings: &[&str], sep: &str) -> Option<String> {
    if strings.is_empty() {
        return None;
    }

    Some(
        strings
            .iter()
            .map(|val| url_encode(val.as_bytes()))
            .collect::<Vec<String>>()
            .join(sep),
    )
}

/// URL-encode channels list.
///
/// Channels list used as part of URL path and therefore required.
#[cfg(any(feature = "subscribe", feature = "presence"))]
pub(crate) fn url_encoded_channels(channels: &[String]) -> String {
    join_url_encoded(
        channels
            .iter()
            .map(|v| v.as_str())
            .collect::<Vec<&str>>()
            .as_slice(),
        ",",
    )
    .unwrap_or(",".into())
}

/// URL-encode channel groups list.
#[cfg(any(feature = "subscribe", feature = "presence"))]
pub(crate) fn url_encoded_channel_groups(channel_groups: &[String]) -> Option<String> {
    join_url_encoded(
        channel_groups
            .iter()
            .map(|v| v.as_str())
            .collect::<Vec<&str>>()
            .as_slice(),
        ",",
    )
    .filter(|string| !string.is_empty())
}