Struct UlcpSessionSnapshotRecord 

pub struct UlcpSessionSnapshotRecord {
    pub generation: u64,
    pub phase: UlcpSessionPhase,
    pub host_ownership: UlcpHostOwnership,
    pub device_key: Option<Vec<u8>>,
    pub device_name: Option<String>,
    pub battery: Option<UlcpBatteryRecord>,
    pub alert: Option<UlcpAlertState>,
    pub time: Option<UlcpTimeRecord>,
    pub gnss: Option<UlcpGnssRecord>,
    pub provisioning: Option<UlcpSyncRecord>,
}

Typed state published after each bounded ULCP-session transition.

Not Eq: a position is degrees, and floating point has no total equality to offer.

Fields

generation: u64

phase: UlcpSessionPhase

host_ownership: UlcpHostOwnership

device_key: Option<Vec<u8>>

device_name: Option<String>

battery: Option<UlcpBatteryRecord>

alert: Option<UlcpAlertState>

PROP_ALERT, or None on a radio without CAP_ALERT.

Unlike battery, this is carried on every snapshot rather than reported once: it is state the UI mirrors, and the radio ends an alert on its own — a button press or its deadline — so the button must follow the radio rather than what the phone last asked for.

time: Option<UlcpTimeRecord>

A clock reading that arrived with this update, on a CAP_TIME device. Reported once — see UlcpTimeRecord.

gnss: Option<UlcpGnssRecord>

What the receiver reports, on a CAP_GNSS device, or None until the first positioning property is read. Mirrored like alert rather than taken like battery.

provisioning: Option<UlcpSyncRecord>

Trait Implementations

impl Clone for UlcpSessionSnapshotRecord

fn clone(&self) -> UlcpSessionSnapshotRecord

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for UlcpSessionSnapshotRecord

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for UlcpSessionSnapshotRecord

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for UlcpSessionSnapshotRecord

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for UlcpSessionSnapshotRecord

type FfiType = <UlcpSessionSnapshotRecord as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for UlcpSessionSnapshotRecord

type LiftType = UlcpSessionSnapshotRecord

impl<UT> LiftReturn<UT> for UlcpSessionSnapshotRecord

type ReturnType = <UlcpSessionSnapshotRecord as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for UlcpSessionSnapshotRecord

type FfiType = <UlcpSessionSnapshotRecord as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for UlcpSessionSnapshotRecord

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for UlcpSessionSnapshotRecord

type ReturnType = <UlcpSessionSnapshotRecord as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for UlcpSessionSnapshotRecord

fn eq(&self, other: &UlcpSessionSnapshotRecord) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for UlcpSessionSnapshotRecord

const TYPE_ID_META: MetadataBuffer

impl StructuralPartialEq for UlcpSessionSnapshotRecord