cranpose_services/
lib.rs

1#![deny(missing_docs)]
2#![doc = include_str!("../README.md")]
3
4#[cfg(test)]
5use cranpose_core::{Composition, MemoryApplier, location_key};
6
7pub mod accessibility_options;
8pub mod accessibility_state;
9pub mod app_info;
10pub mod app_update;
11pub mod async_io;
12pub mod audio;
13pub mod background;
14pub mod browser_history;
15pub mod bundled_assets;
16pub mod camera;
17mod composition_locals;
18pub mod content;
19pub mod device_info;
20mod durable_save;
21pub mod file_picker;
22#[cfg(not(target_arch = "wasm32"))]
23pub mod github_release_updater;
24pub mod haptics;
25pub mod heart_rate;
26#[cfg(not(target_arch = "wasm32"))]
27mod helper_process;
28pub mod host;
29pub mod host_messages;
30pub mod host_surface;
31/// HTTP requests, downloads and the client that sends them.
32pub mod http;
33#[cfg(feature = "image-loading")]
34pub mod image_loading;
35pub mod image_picker;
36pub mod incoming_share;
37pub mod launch_args;
38pub mod launcher;
39pub mod media;
40pub mod memory_pressure;
41pub mod microphone_permission;
42pub mod microphone_standby;
43pub mod navigation;
44pub mod network_status;
45pub mod notifier;
46#[cfg(not(target_arch = "wasm32"))]
47pub mod peer;
48pub mod power;
49pub mod preferences;
50pub mod purchases;
51mod registry;
52pub mod share_sheet;
53pub mod storage;
54/// The light or dark appearance of the operating system.
55pub mod theme;
56mod thread_state;
57/// Opening a URI, such as a web link, in the application the platform picks for it.
58pub mod uri_handler;
59pub mod wearable;
60pub mod wearable_framed;
61pub mod writable_folder;
62
63pub use accessibility_options::{
64    AccessibilityOptions, ProvideAccessibilityOptions, local_accessibility_options,
65    platform_accessibility_options, set_platform_accessibility_options,
66};
67pub use accessibility_state::{
68    AccessibilityState, ProvideAccessibilityState, local_accessibility_state,
69    platform_accessibility_state, set_platform_accessibility_state,
70};
71pub use app_info::{
72    AppInfo, AppInfoRef, app_info, build_version, clear_platform_app_info, set_platform_app_info,
73    version_name,
74};
75pub use app_update::{
76    AppUpdateCapabilities, AppUpdateError, AppUpdateObserver, AppUpdateStatus, AppUpdater,
77    AppUpdaterRef, DigestAlgorithm, DigestVerifier, GitHubReleaseUpdate, PackageDigest,
78    UpdatePackage, app_update_capabilities, app_update_checks_supported, app_update_status,
79    app_updates_supported, check_for_app_update, clear_platform_app_updater, install_app_update,
80    observe_app_update_status, set_app_update_status, set_platform_app_updater, sha256_hex,
81    verify_package,
82};
83pub use async_io::{ChunkChannel, ChunkNext, ChunkStream, MAX_PENDING_CHUNKS, Signal, SignalWait};
84pub use audio::{
85    AudioBus, AudioClip, AudioError, AudioPlayer, AudioPlayerRef, NoopAudioPlayer, PlaybackParams,
86    ProvideAudio, SoundBank, SoundBankEntry, SoundBankFailure, SoundId, SoundSpec, VoiceId,
87    clear_platform_audio, default_audio, local_audio, rememberSoundBank, set_platform_audio,
88};
89pub use background::{
90    BackgroundActivity, BackgroundActivityRef, BackgroundWork, BackgroundWorkLease,
91    acquire_background_work, background_active, background_activity,
92    clear_platform_background_activity, set_platform_background_activity,
93};
94pub use browser_history::{
95    BrowserHistory, BrowserHistoryObserver, BrowserHistoryRef, browser_history,
96    clear_platform_browser_history, set_platform_browser_history,
97};
98#[cfg(not(target_arch = "wasm32"))]
99pub use bundled_assets::{
100    BundledAssetEntry, BundledAssetInstallOutcome, BundledAssetInstallSpec,
101    install_bundled_asset_set,
102};
103pub use bundled_assets::{
104    BundledAssetError, BundledAssetReader, BundledAssets, BundledAssetsRef, StreamingAssetReader,
105    bundled_assets, clear_platform_bundled_assets, set_platform_bundled_assets,
106};
107pub use camera::{
108    Camera, CameraError, CameraFrame, CameraLens, CameraLenses, CameraObserver, CameraRef,
109    CameraState, CameraStill, FlashMode, FrameFormat, LensFacing, UprightRgba, camera,
110    camera_lenses, camera_state, camera_supported, capture_camera_still, clear_platform_camera,
111    dropped_camera_frames, latest_camera_frame, observe_camera_frames, observe_camera_lenses,
112    observe_camera_state, observe_camera_stills, publish_camera_frame, publish_camera_lenses,
113    publish_camera_state, publish_camera_still, record_dropped_camera_frame, rememberCameraFrames,
114    rememberCameraLenses, rememberCameraState, rememberCameraStills, request_camera_still,
115    set_platform_camera, start_camera, stop_camera,
116};
117#[cfg(not(target_arch = "wasm32"))]
118pub use content::{
119    BlockingSink, FileContent, FileFolder, FileSink, copy_content, file_content, file_folder,
120    open_threaded, read_full, run_threaded, threaded_sink,
121};
122pub use content::{
123    BytesContent, Content, ContentChannel, ContentEntry, ContentError, ContentFolder,
124    ContentFolderRef, ContentFuture, ContentHandle, ContentMetadata, ContentReader,
125    ContentReaderRef, ContentResolver, ContentResolverRef, ContentSink, ContentSinkRef,
126    ContentStream, ContentStreamRef, DEFAULT_CHUNK_LEN, ReadyFolder,
127    clear_platform_content_resolver, collect_stream, drain_reader, folder_files, percent_decode,
128    percent_decode_lossy, resolve_content, set_platform_content_resolver, write_all,
129};
130pub use device_info::{
131    DeviceInfo, DeviceInfoRef, clear_platform_device_info, device_info, release_free_memory,
132    set_platform_device_info,
133};
134pub use durable_save::SaveableRegistration;
135pub use file_picker::{
136    FileFilter, FilePicker, FilePickerError, FilePickerOptions, FilePickerRef, PickerFuture,
137    ProvideFilePicker, RecoveredPick, SaveDocumentRequest, clear_platform_file_picker,
138    default_file_picker, local_file_picker, set_platform_file_picker,
139};
140#[cfg(not(target_arch = "wasm32"))]
141pub use github_release_updater::GitHubAppUpdater;
142pub use haptics::{
143    HapticEffect, HapticError, HapticFeedback, HapticPattern, Haptics, HapticsRef, ProvideHaptics,
144    clear_platform_haptics, default_haptics, local_haptics, set_platform_haptics,
145};
146pub use heart_rate::{
147    HeartRate, HeartRateError, HeartRateMonitor, HeartRateMonitorRef, HeartRatePermission,
148    HeartRateReader, HeartRateStatus, clear_platform_heart_rate, heart_rate, heart_rate_available,
149    heart_rate_permission, observe_heart_rate, publish_heart_rate, publish_heart_rate_permission,
150    rememberHeartRate, request_heart_rate_permission, set_platform_heart_rate,
151};
152#[cfg(not(target_arch = "wasm32"))]
153pub use helper_process::windowless_command;
154pub use host::{
155    DEFAULT_DURABLE_SAVE_DEADLINE, DurableSaveEffect, DurableSaveError, DurableSaveOutcome,
156    DurableSaveRegistration, HostController, HostControllerRef, LifecycleEvent, LifecycleObserver,
157    LifecycleState, PlatformDirectories, PlatformDirectoryError, ProvideLifecycle,
158    advance_lifecycle, application_directories, application_id, background_app,
159    clear_application_id, clear_host_controller, current_lifecycle_state, dispatch_lifecycle,
160    dispatch_lifecycle_state, durable_save_deadline, exit_app, host_controller,
161    local_lifecycle_state, observe_lifecycle, register_durable_save, register_preference_save,
162    rememberLifecycleEvents, rememberLifecycleState, run_durable_saves, set_application_id,
163    set_host_controller, set_keep_screen_on, window_lifecycle_state,
164};
165pub use host_messages::{
166    HostMessage, HostMessageObserver, clear_host_messages, clear_host_outbox, install_host_outbox,
167    observe_host_messages, publish_host_message, rememberHostMessages, send_to_host,
168};
169pub use host_surface::{
170    HostSurface, HostSurfaceObserver, HostSurfaceRef, HostSurfaceSize, ResizeRefused,
171    clear_platform_host_surface, host_surface, host_surface_size, observe_host_surface_size,
172    publish_host_surface_size, rememberHostSurfaceSize, request_host_surface_size,
173    set_platform_host_surface,
174};
175pub use http::{
176    BytesBody, CancelTransfer, HttpBody, HttpBodyRef, HttpClient, HttpClientRef, HttpControl,
177    HttpError, HttpFuture, HttpMethod, HttpProgress, HttpRequest, HttpResponse, ProgressHandler,
178    StubAnswer, StubHttpClient, default_http_client, http_body_ref, local_http_client,
179    map_ordered_concurrent,
180};
181#[cfg(not(target_arch = "wasm32"))]
182pub use http::{PlatformDownloader, downloaded_length, set_platform_downloader};
183#[cfg(feature = "image-loading")]
184pub use image_loading::{
185    ImageCacheLimits, ImageLoadError, ImageLoadState, ImageLoader, ImageRequest, image_loader,
186    rememberAsyncImage,
187};
188pub use image_picker::{
189    IMAGE_EXTENSIONS, ImagePicker, ImagePickerError, ImagePickerRef, ImageSource,
190    ProvideImagePicker, clear_platform_image_picker, default_image_picker, local_image_picker,
191    set_platform_image_picker,
192};
193pub use incoming_share::{
194    IncomingContent, IncomingContentObserver, IncomingSource, clear_incoming_content,
195    observe_incoming_content, publish_incoming_content, rememberIncomingContent,
196};
197pub use launch_args::{
198    LaunchArgValue, LaunchArgs, LaunchArgsRef, ProvideLaunchArgs, clear_platform_launch_args,
199    is_debuggable, isDebuggable, launch_args, launch_args_from_command_line, local_launch_args,
200    set_platform_launch_args,
201};
202pub use launcher::{
203    ExportFileLauncher, LauncherResult, OpenFileLauncher, OpenFilesLauncher, OpenFolderLauncher,
204    SaveDocumentLauncher, WritableFolderLauncher, clear_launcher_state, rememberExportFileLauncher,
205    rememberOpenFileLauncher, rememberOpenFilesLauncher, rememberOpenFolderLauncher,
206    rememberSaveDocumentLauncher, rememberWritableFolderLauncher,
207};
208pub use media::{
209    AudioFocus, DUCKED_GAIN, EqualizerBand, EqualizerSettings, MediaArtwork, MediaCapabilities,
210    MediaCommand, MediaError, MediaItem, MediaMetadata, MediaObserver, MediaPlayer, MediaPlayerRef,
211    MediaSamples, MediaSourceHandle, MediaSourceOpener, MediaSourceOpenerRef,
212    OCTAVE_BAND_CENTERS_HZ, PlaybackProgress, PlaybackState, audio_focus,
213    clear_platform_media_player, clear_platform_media_source_opener, current_media_item,
214    dropped_media_samples, latest_media_samples, media_capabilities, media_equalizer,
215    media_equalizer_bands, media_playback_supported, media_player, media_volume,
216    observe_audio_focus, observe_media_commands, observe_media_samples, observe_playback_progress,
217    observe_playback_state, octave_equalizer_bands, open_media, open_media_source, path_from_uri,
218    pause_media, play_media, playback_progress, playback_state, probe_media_duration,
219    publish_audio_focus, publish_media_command, publish_media_samples, publish_playback_progress,
220    publish_playback_state, record_dropped_media_samples, rememberAudioFocus,
221    rememberMediaCommands, rememberMediaSamples, rememberPlaybackProgress, rememberPlaybackState,
222    seek_media, seek_media_fraction, set_media_analysis_enabled, set_media_balance,
223    set_media_equalizer, set_media_looping, set_media_metadata, set_media_speed, set_media_volume,
224    set_platform_media_player, set_platform_media_source_opener, stop_media, toggle_media,
225    uri_for_path,
226};
227pub use memory_pressure::{
228    MemoryPressure, MemoryPressureObserver, observe_memory_pressure, publish_memory_pressure,
229    rememberMemoryPressure,
230};
231pub use microphone_permission::{
232    MicrophoneAccess, MicrophonePermission, MicrophonePermissionObserver, microphone_permission,
233    observe_microphone_permission, open_microphone_settings, prepare_microphone,
234    publish_microphone_permission, rememberMicrophonePermission, request_microphone_permission,
235    set_platform_microphone_access,
236};
237pub use microphone_standby::{
238    MicrophoneStandby, MicrophoneStandbyLease, hold_microphone_standby,
239    microphone_standby_available, set_platform_microphone_standby,
240};
241pub use navigation::{
242    BackEdge, BackEvent, BackGesture, BackHandler, BackRequestObserver, PredictiveBackHandler,
243    back_interception_enabled, exit_requested, observe_back_requests, push_back_gesture,
244    push_back_request, request_exit, set_back_interception, take_back_requests, take_exit_request,
245};
246pub use network_status::{
247    Connectivity, Metering, NetworkMonitor, NetworkMonitorRef, NetworkStatus,
248    clear_platform_network_monitor, network_monitor, network_status, set_platform_network_monitor,
249};
250pub use notifier::{
251    Notifier, NotifierRef, NotifyRequest, ProvideNotifier, clear_platform_notifier,
252    default_notifier, local_notifier, push_notification_deeplink, set_platform_notifier,
253    take_notification_deeplink,
254};
255#[cfg(not(target_arch = "wasm32"))]
256pub use peer::{
257    ByteSource, BytesSource, FetchResult, PeerError, PeerServer, SourceResolver, content_length,
258    fetch_range, fetch_to_writer,
259};
260pub use power::{
261    BatteryStatus, PowerCapabilities, PowerMonitor, PowerMonitorRef, PowerObserverRegistration,
262    PowerReading, PowerState, ThermalState, clear_platform_power_monitor, observe_power_state,
263    power_capabilities, power_monitor, power_state, publish_power_state, rememberPowerState,
264    set_platform_power_monitor,
265};
266#[cfg(all(target_arch = "wasm32", feature = "preferences-web"))]
267pub use preferences::BrowserPreferences;
268#[cfg(not(target_arch = "wasm32"))]
269pub use preferences::FilePreferences;
270pub use preferences::{
271    MemoryPreferences, PreferencesError, PreferencesRef, PreferencesStore, ProvideSaveableScope,
272    SaveableScope, Saver, clear_platform_preferences, preferences, rememberSaveable,
273    set_platform_preferences,
274};
275pub use purchases::{
276    Product, PurchaseEvent, Purchases, PurchasesRef, StoreObserver, StorePhase, StoreState,
277    clear_platform_purchases, note_store_news, observe_store_news, purchases,
278    rememberPurchaseEvents, rememberStoreState, set_platform_purchases, store_available,
279    store_state,
280};
281pub use share_sheet::{
282    ProvideShareSheet, ShareContent, ShareError, ShareSheet, ShareSheetRef,
283    clear_platform_share_sheet, default_share_sheet, local_share_sheet, set_platform_share_sheet,
284};
285pub use storage::{StorageSpace, StorageSpaceRef, available_storage, set_platform_storage_space};
286pub use theme::{
287    ProvideSystemTheme, SystemTheme, clear_platform_system_theme, default_system_theme,
288    isSystemInDarkTheme, known_system_theme, local_system_theme, set_platform_system_theme,
289};
290pub use uri_handler::{
291    ProvideUriHandler, UriHandler, UriHandlerError, UriHandlerRef, clear_platform_uri_handler,
292    default_uri_handler, local_uri_handler, set_platform_uri_handler,
293};
294pub use wearable::{
295    WearableError, WearableEvent, WearableLink, WearablePeer, WearableReceiver, WearableStream,
296    open_on_wearable_peer, open_wearable_stream, publish_wearable_event, send_wearable_message,
297    set_platform_wearable_link, set_wearable_receiver, wearable_peers,
298};
299pub use wearable_framed::{FramedWearableLink, WearableTransport};
300pub use writable_folder::{
301    FolderEntry, FolderError, FolderReader, FolderWriter, WritableFolderStore,
302    WritableFolderStoreRef, open_writable_folder, set_writable_folder_store_factory,
303};
304
305#[cfg(test)]
306pub(crate) type TestComposition = Composition<MemoryApplier>;
307
308#[cfg(test)]
309pub(crate) fn test_scratch_dir(tag: &str) -> std::path::PathBuf {
310    cranpose_core::test_scratch_dir(env!("CARGO_MANIFEST_DIR"), tag)
311}
312
313#[cfg(test)]
314pub(crate) fn run_test_composition(build: impl FnMut()) -> TestComposition {
315    let mut composition = Composition::new(MemoryApplier::new());
316    composition
317        .render(location_key(file!(), line!(), column!()), build)
318        .expect("initial render succeeds");
319    composition
320}
321
322/// What a composable read while a test composition ran once, or `None` when
323/// the read never ran.
324#[cfg(test)]
325pub(crate) fn captured_in_composition<T: Copy + 'static>(
326    read: impl Fn() -> T + 'static,
327) -> Option<T> {
328    let captured = std::rc::Rc::new(std::cell::Cell::new(None));
329    let sink = std::rc::Rc::clone(&captured);
330    run_test_composition(move || sink.set(Some(read())));
331    captured.get()
332}
cranpose_services/lib.rs

cranpose_services/
lib.rs
