Lib.rs

Cargo Features

riot-wrappers has no features set by default.

[dependencies]
riot-wrappers = { version = "0.9.1", features = ["set_panic_handler", "panic_handler_format", "panic_handler_crash", "provide_critical_section_1_0", "with_coap_handler", "with_embedded_nal", "with_embedded_nal_async", "with_embedded_hal_async", "with_msg_v2", "actual_never_type", "nightly_docs"] }

set_panic_handler

Set a panic handler.

Unless a panic handler is provided by another mechanism, exactly one crate in an application should set this feature.

panic_handler_format

If present, the panic handler uses string formatting to produce an error message. Otherwise, it just writes a static panic message to stdout.

panic_handler_crash

If present, the panic handler calls to core_panic and thus halts the full system. Otherwise, the panic in thread mode outside of a critical section only affects that single thread.

provide_critical_section_1_0

Provide an implementation of critical-section 1.0 using irq_disable()/_restore().

Enables restore-state-u32 of critical-section

with_coap_message with_coap_handler

with_embedded_nal = embedded-nal, embedded-nal-tcpextensions, no-std-net-0-5

Affects riot-wrappers::socket_embedded_nal, riot-wrappers::socket_embedded_nal_tcp…

with_embedded_nal_async = embedded-io-async, embedded-nal-async-0-7, no-std-net-0-6

Affects riot-wrappers::socket_embedded_nal_async_udp…

with_embedded_hal_async = embedded-hal-async

with_msg_v2

See msg::v2 documentation. Enabling this exposes components not under semver guarantees.

Affects netreg::register_for_messages…

actual_never_type nightly_docs?

Use actual ! rather than the stable Never workaround. As far as the workaround is understood, this causes no actual change in any types, just in the private names that are assigned to them.

This is primarily for documentation building; enabling it may also help users of nightly when they see a mess of types.

nightly_docs = actual_never_type

Enable documentation enhancements that depend on nightly
This has some effects of its own (making ValueInThread fundamental), and also enables actual_never_type.

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

embedded-nal with_embedded_nal?

Enables embedded-nal ^0.6.0

embedded-nal-tcpextensions with_embedded_nal?

embedded-nal-async-0-7 with_embedded_nal_async?

Enables embedded-nal-async ^0.7.1

embedded-io-async with_embedded_nal_async?

no-std-net-0-5 with_embedded_nal?

Enables no-std-net ^0.5

as used in embedded-nal 0.6

no-std-net-0-6 with_embedded_nal_async?

Enables no-std-net

as used in embedded-nal-async

embedded-hal-async with_embedded_hal_async?

Affects ztimer::Delay…

critical-section provide_critical_section_1_0?