[go: up one dir, main page]

cobs 0.3.0

This is an implementation of the Consistent Overhead Byte Stuffing (COBS) algorithm. COBS is an algorithm for transforming a message into an encoding where a specific value (the "sentinel" value) is not used. This value can then be used to mark frame boundaries in a serial communication channel.
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

[dependencies.defmt]
optional = true
version = "0.3"

[dependencies.serde]
features = ["derive"]
optional = true
version = "1"

[dependencies.thiserror]
default-features = false
version = "2"

[dev-dependencies.quickcheck]
version = "1"

[features]
alloc = []
default = ["std"]
std = ["alloc", "thiserror/std"]
use_std = ["std"]

[lib]
name = "cobs"
path = "src/lib.rs"

[package]
authors = ["Allen Welkie <>", "James Munns <james@onevariable.com>"]
autobenches = false
autobins = false
autoexamples = false
autolib = false
autotests = false
build = false
description = '''
    This is an implementation of the Consistent Overhead Byte Stuffing (COBS) algorithm.
    COBS is an algorithm for transforming a message into an encoding where a specific value
    (the "sentinel" value) is not used. This value can then be used to mark frame boundaries
    in a serial communication channel. '''
edition = "2021"
keywords = ["consistent", "overhead", "byte", "stuffing", "encoding"]
license = "MIT OR Apache-2.0"
name = "cobs"
readme = "README.md"
repository = "https://github.com/jamesmunns/cobs.rs"
version = "0.3.0"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--generate-link-to-definition"]

[[test]]
name = "tests"
path = "tests/tests.rs"