libdonut-rs 0.1.0

Public API for the Donut-rs project
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

//! # Donut Loader API
//!
//! Public API for configuring and building Donut instances.
//!
//! ## Example
//!
//! ```rust
//! use std::io;
//! use libdonut_rs::{Donut, DonutConfig, DonutHttpInstance};
//!
//! fn main() -> io::Result<()> {
//!     let http_opts = DonutHttpInstance::new("http://127.0.0.1:9001", Some("/payload.bin"), 5, Some("GET"), false);
//!     let cfg = DonutConfig::new("C:\\Windows\\System32\\calc.exe").http_options(Some(http_opts));
//!     println!("Created config: {cfg:?}");
//!
//!     let mut donut = Donut::new(&cfg)?;
//!     println!("Created donut object");
//!     let bp = donut.build()?;
//!     println!("Finished building donut object");
//!
//!     let payload = bp.payload();
//!     let metadata = bp.metadata();
//!     println!("Metadata: {metadata:?}");
//!     println!("Payload size: {}", payload.len());
//!     Ok(())
//! }
//! ```
//! ## Versioning
//!
//! - API version 5 is the current ([`DONUT_API_VERSION`]).
//!
//! ## Notes
//!
//! - This crate is under active development. APIs may change.

#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]

extern crate alloc;
#[cfg(feature="loader")]
extern crate core;

/// Crate-wide error types.
mod errors;

/// Platform-specific bindings, structs, and types.
mod platform;

/// Common structs, types, and enums used across components.
mod types;

/// Public instance API.
mod instance;

/// Internal utilities.
mod utils;

/// Builder API (std-only).
#[cfg(feature = "std")]
mod builder;

/// Compression utilities
mod compression;

/// Donut configuration code (std-only)
#[cfg(feature = "std")]
mod config;

/// Cryptographic helpers and utilities
mod crypto;

/// Filesystem utilities (std-only)
#[cfg(feature = "std")]
mod fs;
/// Module re-exports
pub mod prelude;
#[cfg(feature = "std")]
mod donut;

/// API version const
pub const DONUT_API_VERSION: u32 = 5;

/// Header value for the instance (debug mode)
pub const DONUT_DEBUG_INSTANCE_VERSION: &[u8; 23] = b"DONUT_INSTANCE_VERSION=";
#[cfg(feature = "std")]
pub use prelude::{Donut, DonutConfig, DonutInstanceStub, DonutHttpInstance};
pub use prelude::{DonutModule, DonutInstance,DonutResult, DonutError};