Skip to main content

plexus_core/plexus/
mod.rs

1// Guidance system removed during caller-wraps streaming architecture refactor
2// pub mod guidance;
3
4pub mod auth;
5/// AUTH-5: the `auth` activation and what a service supplies it.
6pub mod auth_activation;
7pub mod auth_params;
8/// AUTH-5: a reference in-memory backend and stores for the `auth` activation.
9pub mod auth_memory;
10pub mod test_validator;
11/// MACRO-20: a hub sees through its activations' static children.
12pub mod children;
13pub mod context;
14// RETURNS-10: canonical schema JSON and the SHA-256/16 hash every schema hash is.
15pub mod content_hash;
16pub mod credential_envelope;
17pub mod dispatch;
18/// BIDIR-8 (BIDIR-5's rule): the gate over a duplex call — open, admit,
19/// re-verify on the gate's grants generation, answer, audit.
20pub mod duplex_gate;
21pub mod errors;
22pub mod forward_registry;
23/// AUTH-2: the grant gate in dispatch, and the task-local reach.
24pub mod grant_gate;
25pub mod hub_context;
26/// RETURNS-40: the IR a service writes of itself — IR 3.0, as synapse builds it.
27pub mod ir;
28// MACRO-2.B3: the in-process transport for the macro-generated typed client.
29pub mod in_process;
30/// BIDIR-6: `Input<T>`, the input half of a call.
31pub mod input;
32/// LOCAL-6: a whole hub, called in memory.
33pub mod hub_transport;
34pub mod method_enum;
35pub mod middleware;
36pub mod path;
37pub mod plexus;
38// POLYGLOT-5: the child seam's second implementation — a process or a socket.
39// PLEXUS-45: native only. A browser has no processes, and a ws child waits
40// for a browser-WebSocket transport (a later ticket); on wasm32 the module
41// would compile to a child with no way to reach it.
42#[cfg(not(target_arch = "wasm32"))]
43pub mod remote_child;
44pub mod schema;
45// NEST-11: which service a call is routed in.
46pub mod service_scope;
47/// NEST-5: slot types and slot grants.
48pub mod slots;
49/// NEST-7: the primitive — an activation returns an activation.
50pub mod peer;
51mod schema_sites;
52pub(crate) mod scope_gate;
53pub mod streaming;
54pub mod types;
55/// AUTH-4: the caller's view of a gated hub.
56pub mod view;
57/// PERF-7: the item path — each item encoded once, straight into the frame
58/// its socket writes.
59pub mod wire;
60
61// AuthContext + SessionValidator + the sealed Principal / VerifiedUser /
62// ServiceIdentity types are re-exported from plexus-auth-core via
63// plexus::auth. New code should import directly from plexus_auth_core.
64pub use auth::{AuthContext, Principal, ServiceIdentity, SessionValidator, VerifiedUser, Anonymous, CallSite, ForwardDerivation, ForwardPolicy, ForwardPolicyName, IdentityOnly, MethodPath, MethodPathError, PassThrough, ANONYMOUS_NAME, IDENTITY_ONLY_NAME, PASS_THROUGH_NAME};
65pub use test_validator::TestSessionValidator;
66pub use context::PlexusContext;
67pub use in_process::InProcessTransport;
68pub use input::{Delivered, Input, InputTable};
69pub use hub_transport::HubTransport;
70#[cfg(not(target_arch = "wasm32"))]
71pub use remote_child::{Backoff, ChildError, ChildMethods, ChildOptions, ChildSpec, ChildStats, MountTimings, RemoteChild};
72#[cfg(all(feature = "clap", not(target_arch = "wasm32")))]
73pub use remote_child::ChildArgs;
74#[deprecated(note = "Use GuidanceErrorType and GuidanceSuggestion from stream events instead")]
75pub use errors::{GuidedError, GuidedErrorData, TryRequest};
76pub use forward_registry::{ForwardPolicyRegistry, SameService, SAME_SERVICE_NAME};
77pub use grant_gate::{current_reach, with_reach, ForbiddenItem};
78pub use view::View;
79pub use service_scope::WeakService;
80pub use peer::{Contract, FindPeer, Interface, ListPeers, Peer, PeerError, PeerRouter, PeerSlot, PeerTransport, RouterPeer, Stamp};
81pub use auth_activation::{
82    AuthActivation, AuthBackend, AuthClient, AuthEvent, AuthFailure, AuthSetup, LoginAnswer, LoginFlow, MembershipEntry, MembershipStore,
83    Provider, ProviderKind, Requirement, RoleStore, Session, SignupAnswer, StoreError, Waiting, SIGNED_IN_GRANTS,
84};
85pub use auth_memory::{MemoryAuthBackend, MemoryMemberships, MemoryRoles};
86// AUTH-2: the grant model, re-exported so an activation needs only plexus-core.
87pub use plexus_auth_core::grants::{
88    Ceiling, Gate, Grant, GrantSet, Membership, Memberships, Reach, Refusal, Resolve, RoleOrGrant,
89    RoleTable, Roles, ScopeRef, ADMIN, CEILING_KEY,
90};
91#[deprecated(note = "Middleware removed - guidance provided via PlexusStreamEvent::Guidance")]
92pub use middleware::{ActivationRegistry, GuidedErrorMiddleware};
93pub use path::Provenance;
94#[allow(deprecated)]
95pub use plexus::{error_item, Activation, ActivationInfo, AuthzDenyReason, ChildCapabilities, ChildRouter, DynamicHub, PlexusError, TransportErrorKind, plexus_error_to_jsonrpc, route_to_child, PLEXUS_NOTIF_METHOD};
96// RETURNS-6: the wire's typed call failure, re-exported so server code (and
97// the code `#[activation]` emits) names it through plexus-core.
98pub use plexus_client::{DenyReason, ParamProblem, RemoteError};
99// RETURNS-8: a method's progress vocabulary, named by the code
100// `#[plexus_macros::method]` emits (the default `P` of `Progress<T>` is `Note`).
101pub use plexus_client::{Note, Progress};
102pub use crate::types::Handle;
103pub use schema::{
104    AuthPosture, Cardinality, ChildHashes, ChildSummary, DeprecationInfo, MethodExample, MethodRole,
105    MethodSchema, ParamSchema, PluginHashes, PluginSchema, RequiredCredential, Schema,
106    SchemaParams, SchemaProperty, SchemaResult, SchemaType, ViewKind, JSON_TYPES,
107    X_PLEXUS_VALUES,
108};
109pub use types::{PlexusStreamItem, StreamMetadata};
110pub use wire::Shared;
111pub use method_enum::MethodEnumSchema;
112pub use streaming::{PlexusStream, wrap_stream, error_stream, done_stream, progress_stream};
113// RETURNS-8: one wrapper per signature form (`wrap_stream` is the plain-T stream's).
114pub use streaming::{wrap_one, wrap_one_result, wrap_result_stream, wrap_progress_stream, wrap_result_progress_stream};
115// Note: Method enum is auto-generated by hub_macro and exported from plexus module
116pub use dispatch::{HubDispatch, StreamItem, from_dispatch_stream};
117pub use crate::request::PlexusRequestField;
118pub use hub_context::{HubContext, ParentAware, NoParent};