ic-wire 0.3.4

Bounded canonical Postcard contracts for controlled Internet Computer endpoints
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

//! Static metadata for projections of the maintained wire contract.

/// A field in ascending wire-ID order.
#[derive(Clone, Copy, Debug)]
pub struct Field {
    /// Rust field name, without a raw-identifier prefix.
    pub name: &'static str,
    /// Explicit field identity; not a transmitted tag.
    pub id: u32,
    /// Field encoding and bounds.
    pub value: &'static Schema,
}
/// One explicitly tagged enum alternative.
#[derive(Clone, Copy, Debug)]
pub struct Variant {
    /// Source variant name.
    pub name: &'static str,
    /// Transmitted Postcard u32 tag.
    pub id: u32,
    /// Unit or the single payload's encoding.
    pub value: &'static Schema,
}
/// Finite type metadata, emitted by Wire derives and bounded built-ins.
/// Manual Wire implementations default to Opaque and cannot generate bindings.
#[derive(Clone, Copy, Debug)]
#[non_exhaustive]
pub enum Schema {
    /// No trustworthy generated projection is available.
    Opaque,
    /// Zero-byte unit.
    Unit,
    /// A strict boolean byte.
    Bool,
    /// Unsigned integer width in bits.
    Unsigned(u8),
    /// Signed integer width in bits (i8 is a raw two's-complement byte).
    Signed(u8),
    /// Finite IEEE-754 width in bits (32 or 64); preserves signed zero.
    Float(u8),
    /// Bytes with a maximum length.
    Bytes(usize),
    /// UTF-8 text with a maximum byte length.
    Text(usize),
    /// Element schema and maximum count.
    List(&'static Schema, usize),
    /// Element schema and exact count, without a length prefix.
    Array(&'static Schema, usize),
    /// Optional value, with explicit None/Some tags.
    Option(&'static Schema),
    /// Ok and Err payloads respectively.
    Result(&'static Schema, &'static Schema),
    /// Fields in their explicit wire order.
    Record(&'static [Field]),
    /// Alternatives selected by explicit transmitted IDs.
    Enum(&'static [Variant]),
}