magic-ring-buffer 0.1.0

A magic ring buffer (also known as a virtual ring buffer, VRB, or mirrored buffer) which is lock-free for multiple producers and a single consumer.
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

// This file is part of magic-ring-buffer. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/magic-ring-buffer/master/COPYRIGHT. No part of magic-ring-buffer, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2019 The developers of magic-ring-buffer. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/magic-ring-buffer/master/COPYRIGHT.


/// An error that can occur during creation of a file descriptor instance.
#[derive(Debug)]
pub enum MirroredMemoryMapCreationError
{
	/// Could not open memory mapping file.
	CouldNotOpenMemoryMappingFile(io::Error),

	/// Could not unlink memory mapping file.
	CouldNotUnlinkMemoryMappingFile(io::Error),

	/// Could not truncate memory mapping file.
	CouldNotTruncateMemoryMappingFile(io::Error),

	/// The per-process limit on the number of open file descriptors would be exceeded.
	PerProcessLimitOnNumberOfFileDescriptorsWouldBeExceeded,

	/// Kernel would be out of memory or the process limit on the number of memory mappings has been reached.
	KernelWouldBeOutOfMemory,
}

impl Display for MirroredMemoryMapCreationError
{
	#[inline(always)]
	fn fmt(&self, f: &mut Formatter) -> fmt::Result
	{
		<MirroredMemoryMapCreationError as Debug>::fmt(self, f)
	}
}

impl error::Error for MirroredMemoryMapCreationError
{
	#[inline(always)]
	fn source(&self) ->  Option<&(error::Error + 'static)>
	{
		use self::MirroredMemoryMapCreationError::*;

		match self
		{
			&CouldNotOpenMemoryMappingFile(ref error) => Some(error),

			&CouldNotUnlinkMemoryMappingFile(ref error) => Some(error),

			&CouldNotTruncateMemoryMappingFile(ref error) => Some(error),

			&PerProcessLimitOnNumberOfFileDescriptorsWouldBeExceeded => None,

			&KernelWouldBeOutOfMemory => None,
		}
	}
}