Expand description
Stable, value-oriented facade for native UMSH mobile applications.
This crate deliberately exposes application operations instead of mirroring
the internal protocol crate graph. Platform bindings should wrap this API;
mobile feature code should not depend on umsh-core directly.
Structs§
- Channel
Preview Record - Safe, non-mutating preview of a channel the user is about to join.
- Gatt
Segment Record - One header-prefixed ATT value produced by ULCP GATT segmentation.
- Mobile
Chat Archive Lookup Record - Mobile
Chat Archive Record - Mobile
Chat Checkpoint Record - Mobile
Chat Compose Batch Record - Mobile
Chat Delivery Record - Mobile
Chat Mutation Record - Mobile
Chat Original Ref - Platform-persisted identity of a previously composed outbound message,
used to target an edit or delete.
session_id/handleidentify it when composed by the current facade session;wire_id/epochare the durable fallback for messages composed before a restart. - Mobile
Counter Store - Durable adapter used by the iOS
umsh_hal::CounterStoreboundary. - Mobile
Gatt Reassembler - Stateful, bounded receiver for Frame Out notifications.
- Mobile
Identity - Identity secret retained by the Rust engine after one controlled unlock transfer. Swift receives only public identity records from this object.
- Mobile
Mesh Advertisement Record - A node-identity bundle received over the mesh, either as a broadcast advertisement or as the reply to an Identity Request.
- Mobile
Mesh Outbound Frame Record - Mobile
Mesh Peer Heard Record - Evidence that a peer was on the air, emitted for every accepted frame regardless of what it carried.
- Mobile
Mesh Ping Event Record - Mobile
Mesh Route Record - The route the MAC currently has cached for one peer.
- Mobile
Mesh RxRecord - Mobile
Mesh Session - Long-lived Rust protocol engine used by the mobile app.
- Mobile
Mesh Session Update Record - Mobile
Ulcp Session - Stateful mobile host session for the ULCP.
- Node
Hint Record - Canonical rendering information for a three-byte node hint.
- Node
Identity Profile Record - The claims a node makes about itself, as an identity bundle carries them.
- Node
Identity Record - Decoded advertised node identity (node-identity.md), UI-safe fields only.
- Node
UriPreview Record - Safe, non-mutating preview of a parsed node URI.
- Public
Identity Record - Public identity information safe to keep in ordinary application models.
- Router
Hint Record - Canonical rendering information for a two-byte router hint.
- Ulcp
Battery Record - UI-relevant fields from a validated
PROP_BATTERYvalue. - Ulcp
Device Config Record - Complete desired configuration of a device’s own domain: what it is and what it does when no phone is attached.
- Ulcp
Gnss Record - What the receiver currently reports, folded from the five positioning telemetry properties.
- Ulcp
Gnss Settings Record - The device’s positioning policy: whether the receiver runs, and what is done with what it finds.
- Ulcp
Operation Error Record - A correlated CRP operation completed with a non-OK
PROP_LAST_STATUS. This is an operation failure, never evidence that the transport framing is corrupt or that the BLE connection should be closed. - Ulcp
Property Frame Record - A validated property-bearing ULCP frame.
- Ulcp
Radio Settings Record - Complete desired live radio configuration. Capability-gated fields must be omitted when the device does not advertise their associated capability.
- Ulcp
Received Frame Record - One validated raw mesh frame delivered by the companion radio.
- Ulcp
Repeater Settings Record - The device identity’s autonomous flood-forwarding policy.
- Ulcp
Session Snapshot Record - Typed state published after each bounded ULCP-session transition.
- Ulcp
Session Update Record - Work produced by the Rust ULCP session. Frames are complete ULCP frames; the platform adapter remains responsible for GATT segmentation and write backpressure.
- Ulcp
Sync Record - Read-only, capability-gated device state gathered after host ownership has been resolved. Counts describe digest forms and contain no key material.
- Ulcp
Time Record PROP_TIME: what the device’s wall clock read when it last reported.
Enums§
- Channel
Kind Record - How a channel’s key is established.
- Counter
Store Error - Identity
Signature State - Authentication state of a standalone node-identity bundle.
- Mobile
Chat Archive Result Kind - Mobile
Chat Delivery State - Mobile
Chat Direction - Mobile
Chat Mutation Kind - Mobile
Error - Stable error categories consumed by platform adapters.
- Mobile
Mesh Error - Mobile
Mesh Ping Outcome - Mobile
Mesh Route Kind - How the MAC will address the next frame sent to a peer.
- Ulcp
Alert State PROP_ALERT: what the radio is doing to make itself findable.- Ulcp
Attach Mode - The two relationships a phone can have with a radio.
- Ulcp
Charge State - The charge state a device reports in
PROP_BATTERY. - Ulcp
FixKind PROP_GNSS_FIX: what kind of position solution the receiver has.- Ulcp
Host Ownership - Authoritative comparison of
PROP_HOST_KEYwith the selected phone identity. - Ulcp
Session Phase - Long-lived host-session phase. Swift maps this value to UI link state but does not implement ULCP transitions itself.
Constants§
- MOBILE_
API_ VERSION - Version of the mobile facade contract.
Functions§
- channel_
conversation_ address - The address of a channel’s group conversation, as the chat records carry it.
- decode_
node_ identity - Decode a persisted advertised-identity payload for display.
- derive_
channel_ id - Derive the two-octet channel identifier for a key.
- derive_
channel_ tint - Derive the three presentation octets for a key — the identifier extended by one byte, so a channel’s colour is stable wherever it is shown.
- format_
channel_ invitation - Build a shareable channel URI.
- generate_
channel_ key - Generate a fresh 32-octet key for a new private channel.
- inspect_
channel_ name - Derive a public channel from a plain name, without a URI.
- inspect_
channel_ uri - Parse a channel URI locally and derive its key and identifier.
- inspect_
node_ uri - Parse a node URI locally and return only validated public identity fields.
- inspect_
peer_ identity - Inspect a pasted peer identity in any user-facing interchange form.
- inspect_
public_ identity - Parse and canonicalize a complete public identity address.
- inspect_
public_ identity_ bytes - Inspect a raw 32-byte Ed25519 public identity received from a trusted wire decoder, returning the same canonical UI-safe representation as an address.
- inspect_
ulcp_ alert - Validate and reduce a
PROP_ALERTvalue. - inspect_
ulcp_ battery - Validate and reduce a
PROP_BATTERYvalue to fields used by mobile UI. - inspect_
ulcp_ property_ frame - Parse and validate a property notification or response.
- inspect_
ulcp_ status - Decode an exact packed status value from
PROP_LAST_STATUS. - inspect_
ulcp_ sync - Validate and reduce the property responses from the read-only post-attach inspection.
- mobile_
api_ version - Return the binding-visible mobile API version.
- node_
uri_ for_ address - Render the canonical shareable node URI for a public identity address.
- node_
uri_ with_ identity - Render the shareable node URI carrying a signed identity bundle:
umsh:n:<address>:<base58 bundle>. - public_
identity_ bytes - Decode a canonical address to the raw public-key bytes carried by ULCP
PROP_HOST_KEY. - region_
code_ description - Render a region code for display. Codes derived from an airport come
back as their three letters; everything else as
0xXXXX, whichregion_code_from_stringreads back. - region_
code_ from_ string - Read a region code from what someone typed, yielding the two wire octets used everywhere else in the ULCP and mesh surfaces.
- render_
node_ hint - Render a node hint using the protocol’s canonical ambiguity rules.
- render_
router_ hint - Render a router hint using the protocol’s canonical ambiguity rules.
- sign_
node_ identity_ bundle - Build and sign a node-identity bundle from a supplied secret key.
- ulcp_
gatt_ segments - Split a ULCP frame into ATT values using the negotiated maximum write length. The returned values include the one-octet SAR header.
- ulcp_
inspection_ properties - Return the authoritative properties needed for the read-only post-attach
inspection, gated by the supplied
PROP_CAPSvalue. - ulcp_
location_ cell_ meters - Approximate width, at the equator, of the cell one location precision
names — 2,500 km at one byte down to 15 cm at seven.
Noneoutside 1–7. - ulcp_
max_ dev_ channels - Capacity of the device identity’s channel list (
PROP_DEV_CHANNEL_KEYS). - ulcp_
max_ dev_ peers - Capacity of the device identity’s peer list (
PROP_DEV_PEERS). - ulcp_
prop_ get - Encode a
CMD_PROP_GETrequest with the shared ULCP codec. - ulcp_
prop_ set - Encode a
CMD_PROP_SETrequest with the shared ULCP codec. - ulcp_
save - Encode a
CMD_SAVErequest with the shared ULCP codec.