Skip to main content

Crate alpine_protocol_sdk

Crate alpine_protocol_sdk 

Source
Expand description

High-level ALPINE SDK built on top of the published protocol bindings. The crate keeps discovery, connection, and streaming lifecycles explicit while favoring a minimal public fa?ade.

Re-exports§

pub use capabilities::CapabilitiesSummary;
pub use capabilities::CapabilityDeprecationRegistry;
pub use capabilities::CapabilityMatchMode;
pub use capabilities::CapabilityValidation;
pub use discovery::DeviceSelectionDecision;
pub use discovery::DeviceSelectionPolicy;
pub use discovery::DeviceTrustState;
pub use discovery::DiscoveryAttempt;
pub use discovery::DiscoveryClient;
pub use discovery::DiscoveryClientOptions;
pub use discovery::DiscoveryDiagnostics;
pub use discovery::DiscoveryDryRun;
pub use discovery::DiscoveryError;
pub use discovery::DiscoveryErrorDetails;
pub use discovery::DiscoveryInterface;
pub use discovery::DiscoveryOutcome;
pub use discovery::DiscoveryResult;
pub use discovery::DiscoveryRetryPolicy;
pub use discovery::DiscoveryTargetKind;
pub use discovery::ProtocolNegotiationReport;
pub use discovery::TrustDecision;
pub use discovery::TrustedDiscoveryOutcome;
pub use environment::detect_environment_issues;
pub use environment::ensure_supported_environment;
pub use environment::EnvironmentIssue;
pub use error::AlpineSdkError;
pub use error::SdkErrorContext;
pub use handshake::connect;
pub use handshake::connect_with_policy;
pub use handshake::connect_with_policy_from_report;
pub use handshake::connect_with_policy_from_report_report;
pub use handshake::connect_with_policy_report;
pub use handshake::ConnectPolicy;
pub use handshake::HandshakeReport;
pub use handshake::HandshakeReportResult;
pub use handshake::TraceStep;
pub use handshake::TraceTimeline;
pub use logging::init_json_logging;
pub use logging::init_pretty_logging;
pub use mode::ClientMode;
pub use network_health::NetworkHealthReport;
pub use phase::claim_discovery;
pub use phase::claim_handshake;
pub use preflight::format_preflight_summary;
pub use quarantine::clear_quarantine;
pub use quarantine::mark_quarantine;
pub use quarantine::quarantine_reason;
pub use quickstart::QuickstartChecklist;
pub use quickstart::QuickstartItem;
pub use self_check::run_sdk_self_check;
pub use session::AlpineClient;
pub use session::ControlCommand;
pub use session::ControlDryRun;
pub use session::ControlOptions;
pub use session::ControlResponse;
pub use session::ControlRetryPolicy;
pub use session::DangerousControlCommand;
pub use session::DeviceState;
pub use session::ProbeError;
pub use session::ProbeOptions;
pub use session::ProbeResult;
pub use session::ProbeState;
pub use session::ProbeStep;
pub use session::SafeClient;
pub use session::SafeClientOptions;
pub use session::SessionGuard;
pub use session::StatusMismatchError;
pub use session::UiBadge;
pub use session::UiSeverity;
pub use simulator::BadDeviceScenario;
pub use simulator::BadDeviceSimulator;
pub use stream::StreamClient;
pub use transport::quic::QuicFrameTransport;
pub use transport::udp::UdpFrameTransport;
pub use trust::enforce_trust_policy;
pub use trust::load_cached_trust_view;
pub use trust::load_or_fetch_trust_view;
pub use trust::parse_root_pubkey_base64;
pub use trust::TrustConfig;
pub use trust::TrustError;
pub use trust::TrustPolicy;
pub use trust::TrustSource;
pub use trust::TrustView;
pub use typestate::ActiveSession;
pub use typestate::TrustedClient;
pub use typestate::UntrustedClient;
pub use vendor::VendorExtensionRegistry;

Modules§

capabilities
discovery
environment
error
handshake
logging
mode
network_health
phase
preflight
quarantine
quickstart
self_check
session
simulator
stream
transport
trust
typestate
vendor

Structs§

AttesterRegistry
CapabilitySet
Declared capabilities as defined by the spec.
DeviceIdentity
Device identity tuple exchanged during discovery and handshake.
HandshakeContext
Context shared between handshake participants.
NodeCredentials
Ed25519 credentials loaded from PEM files.
StreamProfile
High-level description of stream behavior selected by callers.
VerifiedDeviceIdentityAttestation

Enums§

AttestationError
ChannelFormat
Supported channel encodings for frames.