can-socket 0.3.3

no frills CAN sockets (synchronous or async with tokio)
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

/// A CAN interface identified by its index.
///
/// This type is used as a socket address to bind CAN sockets to a specific interface.
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[repr(transparent)]
pub struct CanInterface {
	/// The inner `CanInterface`, directly usable as a socket address for a CAN socket.
	pub(crate) inner: crate::sys::CanInterface,
}

impl CanInterface {
	/// Create a new `CanInterface` from a raw index.
	///
	/// Index `0` represents the "bind all" interface.
	pub fn from_index(index: u32) -> Self {
		Self {
			inner: crate::sys::CanInterface::from_index(index),
		}
	}

	/// Resolve a CAN interface name to a [`CanInterface`].
	pub fn from_name(name: &str) -> std::io::Result<Self> {
		Ok(Self {
			inner: crate::sys::CanInterface::from_name(name)?,
		})
	}

	/// Get the index of the interface.
	pub fn index(&self) -> u32 {
		self.inner.index()
	}

	/// Look up the name of the interface from the index.
	pub fn get_name(&self) -> std::io::Result<String> {
		self.inner.get_name()
	}
}

impl std::fmt::Debug for CanInterface {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		let name = self.get_name();
		let mut debug = f.debug_struct("CanInterface");
		debug.field("index", &self.index());
		if let Ok(name) = &name {
			debug.field("name", name);
		}
		debug.finish()
	}
}