posixmq 1.0.0

An idiomatic library for using posix message queues, with optional mio integration
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

//! Tests of the portable core features.

use std::io::ErrorKind;

extern crate posixmq;
use posixmq::{PosixMq, OpenOptions, remove_queue};

#[test]
fn nonexistant() {
    let _ = remove_queue(b"/404"); // in case it already exists
    assert_eq!(remove_queue("/404").unwrap_err().kind(), ErrorKind::NotFound);
    assert_eq!(PosixMq::open("/404").unwrap_err().kind(), ErrorKind::NotFound);
}

#[test]
fn open_custom_capacities() {
    let attrs = OpenOptions::readonly()
        .capacity(2)
        .max_msg_len(100)
        .create_new()
        .open(b"/custom_capacities")
        .expect("create new /custom_capacities")
        .attributes()
        .expect("get attributes");
    let _ = posixmq::remove_queue(b"/custom_capacities");
    assert_eq!(attrs.capacity, 2);
    assert_eq!(attrs.max_msg_len, 100);
    assert_eq!(attrs.current_messages, 0);
    assert!(!attrs.nonblocking);
}

#[test]
fn create_and_remove() {
    let mq = OpenOptions::readwrite().create_new().open("/flash");
    mq.expect("cannot create");
    remove_queue("/flash").expect("cannot remove queue");
    assert_eq!(PosixMq::open("/flash").unwrap_err().kind(), ErrorKind::NotFound);
}


#[test]
fn is_not_nonblocking() {
    let mq = PosixMq::create("/is_not_nonblocking").unwrap();
    let _ = posixmq::remove_queue("/is_not_nonblocking");
    assert!(!mq.is_nonblocking().expect("get attributes"));
    // TODO test that send and receive blocks?
}

#[test]
fn is_nonblocking() {
    let mq = OpenOptions::readwrite()
        .nonblocking()
        .capacity(1)
        .max_msg_len(1)
        .create()
        .open("/is_nonblocking")
        .unwrap();
    let _ = posixmq::remove_queue("/is_nonblocking");

    assert!(mq.is_nonblocking().expect("get attributes"));
    assert_eq!(mq.recv(&mut[0]).unwrap_err().kind(), ErrorKind::WouldBlock);
    mq.send(5, b"e").unwrap();
    assert_eq!(mq.send(6, b"f").unwrap_err().kind(), ErrorKind::WouldBlock);
}

#[test]
fn change_nonblocking() {
    let mq = PosixMq::create("/change_nonblocking").unwrap();
    let _ = posixmq::remove_queue("/change_nonblocking");
    mq.set_nonblocking(true).unwrap();
    assert!(mq.is_nonblocking().unwrap());
    assert_eq!(mq.recv(&mut[0; 8192]).unwrap_err().kind(), ErrorKind::WouldBlock);
    mq.set_nonblocking(false).unwrap();
    assert!(!mq.is_nonblocking().unwrap());
}


#[test]
fn send_errors() {
    let _ = remove_queue("send");
    let nb = OpenOptions::writeonly()
        .nonblocking()
        .create()
        .max_msg_len(1)
        .capacity(2)
        .open("send")
        .unwrap();
    assert_eq!(nb.send(0, b"too long").unwrap_err().kind(), ErrorKind::Other);

    let bl = OpenOptions::readwrite().open("send").unwrap();
    assert_eq!(bl.send(!0, b"f").unwrap_err().kind(), ErrorKind::InvalidInput);

    nb.send(9, b"a").expect("nonblocking send \"a\"");
    if cfg!(target_os="netbsd") || cfg!(target_os="dragonfly") {// doesn't allow empty messages
        bl.send(0, b"b").expect("blocking send \"b\"");
    } else {
        bl.send(0, b"").expect("blocking send empty");
    }
    assert_eq!(nb.send(0, b"b").unwrap_err().kind(), ErrorKind::WouldBlock);

    let ro = OpenOptions::readonly().open("send").unwrap();
    assert_eq!(ro.send(0, b"").unwrap_err().kind(), ErrorKind::Other); // opened read-only

    let _ = remove_queue("send");
}

#[test]
fn recv_errors() {
    let nb = OpenOptions::readonly()
        .nonblocking()
        .create()
        .max_msg_len(1)
        .capacity(2)
        .open("receive")
        .unwrap();
    assert_eq!(nb.recv(&mut[0; 2]).unwrap_err().kind(), ErrorKind::WouldBlock);
    assert_eq!(nb.recv(&mut[]).unwrap_err().kind(), ErrorKind::Other); // buffer too short
    let wo = OpenOptions::writeonly().open("receive").unwrap();
    assert_eq!(wo.recv(&mut[0; 2]).unwrap_err().kind(), ErrorKind::Other); // opened write-only

    let _ = remove_queue("receive");
}

#[test]
fn send_and_receive() {
    let mq = PosixMq::create(b"/send_and_receive").unwrap();
    let _ = remove_queue(b"/send_and_receive");

    mq.send(2, b"aaaa").unwrap();
    mq.send(4, b"bbb").unwrap();
    mq.send(1, b"cc").unwrap();
    mq.send(3, b"d").unwrap();

    let mut buf = [0; 8192];
    assert_eq!(mq.recv(&mut buf).unwrap(), (4, 3));
    assert_eq!(&buf[..3], b"bbb");
    assert_eq!(mq.recv(&mut buf).unwrap(), (3, 1));
    assert_eq!(&buf[..3], b"dbb");
    assert_eq!(mq.recv(&mut buf).unwrap(), (2, 4));
    assert_eq!(&buf[..4], b"aaaa");
    assert_eq!(mq.recv(&mut buf).unwrap(), (1, 2));
    assert_eq!(&buf[..4], b"ccaa");
}

#[test]
fn iterators() {
    let mq = OpenOptions::readwrite().nonblocking().create().open("/iterable").unwrap();
    let _ = posixmq::remove_queue("/iterable");

    for n in 0..8 {
        mq.send(n, n.to_string().as_bytes()).unwrap()
    }
    assert_eq!(mq.iter().next(), Some((7, "7".to_string().into_bytes())));
    for (priority, message) in &mq {
        assert_eq!(String::from_utf8(message).unwrap().parse::<u32>().unwrap(), priority);
    }
    mq.set_nonblocking(false).unwrap();
    for fruit in &["apple", "pear", "watermelon"] {
        mq.send(fruit.len() as u32, fruit.as_bytes()).unwrap();
    }
    let mut iter = mq.into_iter();
    assert_eq!(iter.next(), Some((10, b"watermelon".to_vec())));
    assert_eq!(iter.next(), Some((5, b"apple".to_vec())));
    assert_eq!(iter.next(), Some((4, b"pear".to_vec())));
}

#[test]
#[should_panic]
fn iterator_panics_if_writeonly() {
    let mq = OpenOptions::writeonly().create().open("writeonly").unwrap();
    let _ = remove_queue("writeonly");
    for (_, _) in mq {

    }
}


#[test]
#[ignore] // racy
fn drop_closes() {
    let mq = PosixMq::create("/close").unwrap();
    let _ = remove_queue("/close");
    let mqd = mq.as_raw_mqd();
    let fake_clone = unsafe { PosixMq::from_raw_mqd(mqd) };
    // cast to usize because pointers cannot be compared directly
    assert_eq!(fake_clone.as_raw_mqd() as usize, mqd as usize);
    fake_clone.send(0, b"b").expect("as_raw_mqd() should not close");
    drop(mq);
    fake_clone.send(0, b"b").expect_err("Drop should have closed the descriptor");
    // also tests that drop ignores errors
}

#[test]
fn into_mqd_doesnt_drop() {
    let mq = PosixMq::create("/raw_mqd").unwrap();
    let _ = remove_queue("/raw_mqd");
    unsafe {
        let mqd = mq.into_raw_mqd();
        let mq = PosixMq::from_raw_mqd(mqd);
        mq.send(0, b"lorem ipsum").expect("descriptor should remain open");
    }
}


#[test]
fn is_send_and_sync() {
    fn is_send<T:Send>() -> bool {true}
    fn is_sync<T:Sync>() -> bool {true}
    is_send::<PosixMq>();
    is_sync::<PosixMq>();
}