nexus-sdk 2.1.1

Rust SDK for Nexus protocol types, RPC access, and transaction construction.
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

//! Canonical authoring and observation types for scheduled Tasks.
//!
//! Scheduling is the only public work request model:
//! [`TaskSpec`](crate::scheduler::TaskSpec) describes the work and its
//! funding, while [`Schedule`](crate::scheduler::Schedule) describes when
//! occurrences of that work may be dispatched.
//!
//! Empty schedules are valid composition values. Use
//! [`Schedule::validate_for_task_creation`](crate::scheduler::Schedule::validate_for_task_creation)
//! when invoking an atomic create and schedule shortcut that requires work:
//!
//! ```
//! use nexus_sdk::scheduler::{Occurrence, Schedule};
//!
//! let schedule = Schedule::new()
//!     .with_occurrence(Occurrence::now())
//!     .with_occurrence(Occurrence::at_ms(2_000));
//!
//! assert_eq!(schedule.occurrences().len(), 2);
//! assert!(schedule.validate_for_task_creation().is_ok());
//! ```

#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]

mod error;
mod model;
mod receipt;
mod snapshot;

#[cfg(feature = "nexus")]
pub use receipt::RecoveryReceipt;
pub use {
    error::{ErrorSource, ScheduleError, SchedulerError},
    model::{
        AuthorizationBindings,
        DispatchOffer,
        FailurePolicy,
        Occurrence,
        OccurrenceRef,
        Recurrence,
        Schedule,
        TaskFunding,
        TaskInputs,
        TaskOperation,
        TaskSpec,
    },
    receipt::{
        AbortReceipt,
        ScheduleDelta,
        ScheduledOccurrence,
        TaskMutationReceipt,
        TransactionReference,
        WithdrawnOccurrence,
    },
    snapshot::{
        ExecutionSnapshot,
        OccurrenceCost,
        OccurrencePage,
        OccurrenceSnapshot,
        OccurrenceSource,
        OccurrenceStatus,
        TaskController,
        TaskPointer,
        TaskPointerPage,
        TaskRejectionReason,
        TaskSnapshot,
        TaskStatus,
        WatchOptions,
        WithdrawalReason,
    },
};
pub(crate) use {
    model::{Deadline, StartTime},
    snapshot::ExecutionObservation,
};

#[cfg(feature = "walrus")]
mod input_json;
#[cfg(feature = "walrus")]
mod input_plan;
#[cfg(feature = "walrus")]
pub use input_plan::TaskInputPlan;