oct 0.35.0

Octonary transcodings.
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

// Copyright 2024-2026 Gabriel Bjørnager Jensen.
//
// SPDX: MIT OR Apache-2.0

//! Serialisation/deserialisation facilities.
//!
//! This module provides portable serialisation and
//! deserialisation algorithms, e.g. for network
//! communications.
//!
//! # Examples
//!
#![cfg_attr(feature = "proc_macro", doc = include_str!("serdes_derive_examples.md"))]

#![doc(alias = "serde")]

#![cfg(feature = "serdes")]

mod deserialise;
mod max_serialised_size;
mod serialise;
mod slot;

pub use deserialise::Deserialise;
pub use max_serialised_size::MaxSerialisedSize;
pub use serialise::Serialise;
pub use slot::Slot;

/// Implements [`Deserialise`] for the given type.
///
/// [`Deserialise`]: trait@Deserialise
#[cfg(feature = "proc_macro")]
#[doc(inline)]
pub use oct_macros::Deserialise;

/// Implements [`MaxSerialisedSize`] for the given type.
///
/// [`MaxSerialisedSize`]: trait@MaxSerialisedSize
#[cfg(feature = "proc_macro")]
#[doc(inline)]
pub use oct_macros::MaxSerialisedSize;

/// Implements [`Serialise`] for the given type.
///
/// [`Serialise`]: trait@Serialise
#[cfg(feature = "proc_macro")]
#[doc(inline)]
pub use oct_macros::Serialise;

/// The discriminant value for [`Bound::Included`].
///
/// [`Bound::Included`]: core::ops::Bound::Included
const BOUND_INCLUDED: u8 = 0;

/// The discriminant value for [`Bound::Excluded`].
///
/// [`Bound::Excluded`]: core::ops::Bound::Excluded
const BOUND_EXCLUDED: u8 = 1;

/// The discriminant value for [`Bound::Unbounded`].
///
/// [`Bound::Unbounded`]: core::ops::Bound::Unbounded
const BOUND_UNBOUNDED: u8 = 2;

/// The discriminant value for [`IpAddr::V4`].
///
/// [`IpAddr::V4`]: core::net::IpAddr::V4
const IP_ADDR_V4: u8 = 4;

/// The discriminant value for [`IpAddr::V6`].
///
/// [`IpAddr::V6`]: core::net::IpAddr::V6
const IP_ADDR_V6: u8 = 6;

/// The discriminant value for [`Option::None`].
const OPTION_NONE: u8 = 0;

/// The discriminant value for [`Option::Some`].
const OPTION_SOME: u8 = 1;

/// The discriminant value for [`SocketAddr::V4`].
///
/// [`SocketAddr::V4`]: core::net::SocketAddr::V4
const SOCKET_ADDR_V4: u8 = 4;

/// The discriminant value for [`SocketAddr::V6`].
///
/// [`SocketAddr::V6`]: core::net::SocketAddr::V6
const SOCKET_ADDR_V6: u8 = 6;

/// The discriminant value for [`Result::Ok`].
const RESULT_OK: u8 = 0;

/// The discriminant value for [`Result::Err`].
const RESULT_ERR: u8 = 1;