interprocess 2.2.2

Interprocess communication toolkit
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

use super::*;

impl RawPipeStream {
	#[track_caller]
	fn send(&self, buf: &[u8]) -> io::Result<usize> {
		let r = {
			let _guard = self.concurrency_detector.lock();
			self.file_handle().write(buf)
		};
		if r.is_ok() {
			self.needs_flush.mark_dirty();
		}
		r
	}

	#[track_caller]
	fn flush(&self) -> io::Result<()> {
		if self.needs_flush.take() {
			let r = self.file_handle().flush();
			if r.is_err() {
				self.needs_flush.mark_dirty();
			}
			r
		} else {
			Ok(())
		}
	}
}

impl<Rm: PipeModeTag, Sm: PipeModeTag + PmtNotNone> PipeStream<Rm, Sm> {
	/// Flushes the stream, blocking until the send buffer is empty (has been received by the other
	/// end in its entirety).
	///
	/// Only available on streams that have a send mode.
	#[inline]
	pub fn flush(&self) -> io::Result<()> {
		self.raw.flush()
	}
	/// Marks the stream as unflushed, preventing elision of the next flush operation (which
	/// includes limbo).
	#[inline]
	pub fn mark_dirty(&self) {
		self.raw.needs_flush.mark_dirty();
	}
	/// Assumes that the other side has consumed everything that's been written so far. This will
	/// turn the next flush into a no-op, but will cause the send buffer to be cleared when the
	/// stream is closed, since it won't be sent to limbo.
	#[inline]
	pub fn assume_flushed(&self) {
		self.raw.needs_flush.take();
	}
	/// Drops the stream without sending it to limbo. This is the same as calling
	/// `assume_flushed()` right before dropping it.
	#[inline]
	pub fn evade_limbo(self) {
		self.assume_flushed();
	}
}

impl<Rm: PipeModeTag> PipeStream<Rm, pipe_mode::Messages> {
	/// Sends a message into the pipe, returning how many bytes were successfully sent (typically
	/// equal to the size of what was requested to be sent).
	///
	/// Interacts with [concurrency prevention](#concurrency-prevention).
	#[inline]
	pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
		self.raw.send(buf)
	}
}

/// Interacts with [concurrency prevention](#concurrency-prevention).
impl<Rm: PipeModeTag> Write for &PipeStream<Rm, pipe_mode::Bytes> {
	#[inline]
	fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
		self.raw.send(buf)
	}
	#[inline]
	fn flush(&mut self) -> io::Result<()> {
		self.raw.flush()
	}
}
/// Interacts with [concurrency prevention](#concurrency-prevention).
impl<Rm: PipeModeTag> Write for PipeStream<Rm, pipe_mode::Bytes> {
	#[inline(always)]
	fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
		(&*self).write(buf)
	}
	#[inline(always)]
	fn flush(&mut self) -> io::Result<()> {
		(&mut &*self).flush()
	}
}