castflip 0.1.12

Library for encoding/decoding numeric variables, arrays and structures in little-endian and big-endian
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

//!
//! Defines experimental traits and historical traits.
//!
//! Active traits in use in the current release.
//!
//! - [`AsifBytes`] converts a reference to a variable or a slice into
//!   a transmuted reference to a slice of bytes without copying data.
//!
//! - [`PushBulk`] defines a method to extend a vector whose
//!   additional slots are filled by the specified closure.
//!
//! Historical traits not in use in the recent releases.  (They will
//! be removed when the version number is bumped up to 0.2.)
//!
//! - [`EncastArg`] and [`DecastArg`] provide some older versions of
//!   APIs of this crate.
//!
//! - [`FlipUnsized`] provides method `flip_var` for a slice and
//!   a tuple.
//!
//! - [`Deslice`], [`Enslice`] and [`Reslice`] are general-purpose
//!   ancestors of [`AsifBytes`].  They convert a reference to a
//!   variable or a slice into a transmuted reference to a slice or a
//!   variable of the specified type without copying data.  Although
//!   it is useful in certain situations, its use cases will be
//!   limited because its methods are considered unsafe.
//!
//! - [`AsBytes`] is an older version of [`AsifBytes`].  It is
//!   deprecated because one of its method names is conflicted with
//!   the one of `mem::MaybeUninit`.  In order to support method
//!   `as_bytes_mut` for `mem::MaybeUninit`, and to avoid possible
//!   other name conflict, [`AsBytes`] is renamed to [`AsifBytes`].
//!


// Modules in use.
#[doc(hidden)] pub mod asif_bytes;
#[doc(hidden)] mod include_doc;
#[doc(hidden)] #[cfg(feature = "alloc")] pub mod push_bulk;

// Modules not in use.
#[doc(hidden)] pub mod as_bytes;
#[doc(hidden)] pub mod decast_arg;
#[doc(hidden)] pub mod deslice;
#[doc(hidden)] pub mod encast_arg;
#[doc(hidden)] pub mod enslice;
#[doc(hidden)] pub mod flip_unsized;
#[doc(hidden)] pub mod reslice;

// Traits in use.
#[doc(inline)] pub use self::asif_bytes::AsifBytes;
#[doc(inline)] #[cfg(feature = "alloc")] pub use self::push_bulk::PushBulk;

// Traits not in use.
#[doc(inline)] pub use self::deslice::Deslice;
#[doc(inline)] pub use self::enslice::Enslice;
#[doc(inline)] pub use self::reslice::Reslice;

#[doc(inline)] pub use self::decast_arg::DecastArg;
#[doc(inline)] pub use self::encast_arg::EncastArg;
#[doc(inline)] pub use self::flip_unsized::FlipUnsized;

#[allow(deprecated)] #[doc(inline)] pub use self::as_bytes::AsBytes;