socketcan 4.0.0

Linux SocketCAN library. Send and receive CAN frames via CANbus on Linux.
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

[package]
name = "socketcan"
version = "4.0.0"
edition = "2024"
rust-version = "1.89"
authors = [
    "Marc Brinkmann <git@marcbrinkmann.de>",
    "Frank Pagliughi <fpagliughi@mindspring.com>"
]
documentation = "https://docs.rs/socketcan"
repository = "https://github.com/mbr/socketcan-rs"
license = "MIT"
description = """
Linux SocketCAN library. Send and receive CAN frames via CANbus on Linux.
"""

# Features:
#
# "netlink" (default) - Whether to include CAN interface configuration
#     capabilities based on netlink kernel communications
#
# "dump" (default) - Whether to include 'candump' log file parsing
#     capabilities.
#
# "enumerate" - Ability to enumerate the available CAN network interfaces
#     (via udev)
#
# "utils" - Build the command-line utilities
#
# "serde" - Serialization support for frames, errors, and interface
#     configuration via serde
#
# "tokio" - Async/await support with tokio
# "smol" - Async/await support for smol using async-io
#
# "vcan_tests" - Run unit tests that require a "vcan0" interface loaded in 
#     the kernel. Use with 'cargo test'.
# "netlink_tests" - Run unit tests for the netlink module. This may require
#     root privileges. Use with 'cargo test'.

[features]
default = ["netlink", "dump"]
netlink = ["neli"]
dump = []
netlink_tests = ["netlink"]
vcan_tests = ["netlink"]
utils = ["clap", "anyhow", "netlink"]
tokio = ["dep:tokio", "futures"]
smol = ["dep:smol", "futures"]
enumerate = ["dep:udev"]
serde = ["dep:serde", "bitflags/serde"]

[dependencies]
embedded-can = "0.4"
nb = "1"
log = "0.4"
hex = "0.4"
libc = { version = "0.2.186", features = ["extra_traits"] }
nix = { version="0.31", features = ["poll", "net"] }
bitflags = "2.6"
smallvec = { version = "1", features = ["union"] }
thiserror = "2"
socket2 = { version = "0.6", features = ["all"] }
clap = { version = "4.6", optional = true }
anyhow = { version = "1", optional = true }
tokio = { version = "1", features = ["net"], optional = true }
futures = { version = "0.3", optional = true }
smol = { version = "2.0", optional = true }
udev = { version = "0.9", optional = true }
serde = { version = "1.0", features = ["derive"], optional = true }

# This hack avoids building neli on non-linux platforms, which
# avoids a ton of compile errors.
[target.'cfg(target_os = "linux")'.dependencies]
neli = { version = "0.7", optional = true }

[dev-dependencies]
anyhow = "1.0"
serde_json = "1"
rmp-serde = "1"
clap = "4.6"
ctrlc = "3.2.2"
nb = "1.0"
futures-timer = "3.0"
futures-util = "0.3"
serial_test = { version = "3.5", features = ["async"]}
tokio = { version = "1", features = ["macros", "rt-multi-thread", "sync", "io-util", "time"] }
futures = "0.3"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
targets = ["x86_64-unknown-linux-gnu", "i686-unknown-linux-gnu"]


[[bin]]
name = "rcan"
required-features = ["utils"]

[[test]]
name = "serde"
path = "tests/serde.rs"
required-features = ["serde"]

[[test]]
name = "cansocket-smol"
path = "tests/cansocket-smol.rs"
required-features = ["smol"]

[[example]]
name = "playlog"
required-features = ["dump"]

[[example]]
name = "enumerate"
# also queries each interface over netlink
required-features = ["enumerate", "netlink"]

[[example]]
name = "tokio_send"
required-features = ["tokio"]

[[example]]
name = "tokio_bridge"
required-features = ["tokio"]

[[example]]
name = "tokio_print_frames"
required-features = ["tokio"]

[[example]]
name = "tokio_average"
required-features = ["tokio"]

[[example]]
name = "tokio_recvts"
required-features = ["tokio"]

[[example]]
name = "smol_send"
required-features = ["smol"]

[[example]]
name = "smol_bridge"
required-features = ["smol"]

[[example]]
name = "smol_print_frames"
required-features = ["smol"]