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

//! Bounded Postcard contracts for controlled IC endpoints.
//!
//! Transport, authentication, semantic validation and replay policy belong to
//! consumers. See the runtime guide for maintained wire rules.
#![no_std]
#![doc = include_str!("../README.md")]
extern crate alloc;
mod bounded;
mod contract;
mod float;
pub mod native;
pub mod schema;
mod shape;
/// Optional host-side TypeScript generation; never required by a canister.
#[cfg(feature = "typescript")]
pub mod typescript;
pub use bounded::{Bytes, List, Text};
pub use contract::{
    Method, RequestBytes, ResponseBytes, decode_request, decode_response, encode_request,
    encode_response, encoded_request_len, encoded_response_len,
};
pub use float::{FiniteF32, FiniteF64};
pub use ic_wire_derive::Wire;
pub use shape::{Limits, Shape, Wire};

/// Implementation dependencies used by generated contracts.
#[doc(hidden)]
pub mod __private {
    pub use serde;
}

/// Typed codec/admission failure, distinct from transport and application errors.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Error {
    /// Wire, collection or text allowance exceeded.
    Limit,
    /// The declared schema exceeds the method's resource allowances.
    SchemaLimit,
    /// Allocation failed within an admitted allowance.
    Allocation,
    /// Invalid or truncated Postcard representation.
    Malformed,
    /// Bytes remain after the expected value.
    Trailing,
    /// A valid value used a noncanonical representation.
    Noncanonical,
    /// Envelope marker, method identity or direction differs.
    Identity,
}
impl core::fmt::Display for Error {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "wire {self:?}")
    }
}
impl core::error::Error for Error {}