UlcpSyncRecord

Struct UlcpSyncRecord 

Source
pub struct UlcpSyncRecord {
Show 47 fields pub capability_count: u32, pub has_host_filtering: bool, pub supports_offline_queue: bool, pub supports_delegated_ack: bool, pub supports_device_name: bool, pub device_name: Option<String>, pub supports_lora: bool, pub supports_duty_cycle_limit: bool, pub supports_battery: bool, pub battery: Option<UlcpBatteryRecord>, pub supports_repeater: bool, pub supports_ident: bool, pub supports_device_identity: bool, pub supports_time: bool, pub supports_gnss: bool, pub supports_advert: bool, pub supports_admin: bool, pub supports_alert: bool, pub supports_reboot: bool, pub alert: Option<UlcpAlertState>, pub phy_enabled: bool, pub frequency_khz: u32, pub transmit_power_dbm: i8, pub bandwidth_hz: Option<u32>, pub spreading_factor: Option<u8>, pub coding_rate_denom: Option<u8>, pub duty_cycle_now: Option<u16>, pub duty_cycle_limit: Option<u16>, pub saved: Option<SavedSnapshotRecord>, pub queued_frames: Option<u16>, pub dropped_frames: Option<u32>, pub filter_count: Option<u32>, pub host_channel_count: Option<u32>, pub host_peer_count: Option<u32>, pub auto_ack: Option<bool>, pub repeater: Option<UlcpRepeaterSettingsRecord>, pub dev_peer_keys: Option<Vec<Vec<u8>>>, pub dev_admin_keys: Option<Vec<Vec<u8>>>, pub dev_channel_ids: Option<Vec<Vec<u8>>>, pub ident_role: Option<u8>, pub ident_mobile: Option<bool>, pub ident_position: Option<UlcpIdentPositionRecord>, pub dev_discoverable: Option<bool>, pub tz_offset_min: Option<i16>, pub gnss: Option<UlcpGnssSettingsRecord>, pub advert: Option<UlcpAdvertSettingsRecord>, pub unreadable_properties: Vec<u32>,
}
Expand description

Read-only, capability-gated device state gathered after host ownership has been resolved. Counts describe digest forms and contain no key material.

Fields§

§capability_count: u32§has_host_filtering: bool§supports_offline_queue: bool§supports_delegated_ack: bool§supports_device_name: bool§device_name: Option<String>

PROP_DEV_NAME, when the device has one and reported it. Empty is a device with no name rather than a device named “”.

§supports_lora: bool§supports_duty_cycle_limit: bool§supports_battery: bool

The device measures its own power state (CAP_BATTERY). A device without it never reports a battery, so callers have nothing to show.

§battery: Option<UlcpBatteryRecord>

PROP_BATTERY, when the device measures one and has reported it.

A reading rather than a setting, and absent for a reason that is never a fault: on the local link a device announces this on its own schedule, so a session that has only just attached has not heard one yet. Deliberately not counted among unreadable_properties — there is no setting here to be written over.

§supports_repeater: bool

The device can forward for the mesh on its own (CAP_REPEATER).

§supports_ident: bool

The device serves and configures its own advertised node identity (CAP_IDENT).

§supports_device_identity: bool

The device has an identity domain of its own (CAP_DEV_IDENTITY), including the PROP_DEV_PEERS list.

§supports_time: bool

The device keeps a wall clock (CAP_TIME). It says nothing about where the time comes from, or whether the device currently knows it — an unset clock is a device with CAP_TIME and no epoch.

§supports_gnss: bool

A GNSS receiver is fitted (CAP_GNSS), so the positioning properties exist and the device can locate itself.

§supports_advert: bool

The device announces itself on a schedule of its own (CAP_ADVERT).

§supports_admin: bool

The device answers Node Management Requests from the administrators it lists (CAP_ADMIN). A device without it can only ever be configured by whoever is holding it.

§supports_alert: bool

The device can make itself conspicuous on request (CAP_ALERT).

§supports_reboot: bool

The device can restart its hardware on request (CAP_REBOOT).

§alert: Option<UlcpAlertState>

PROP_ALERT: what the device is doing to make itself findable, when it has said. Live state like battery, and absent on the same terms.

§phy_enabled: bool§frequency_khz: u32§transmit_power_dbm: i8§bandwidth_hz: Option<u32>§spreading_factor: Option<u8>§coding_rate_denom: Option<u8>§duty_cycle_now: Option<u16>§duty_cycle_limit: Option<u16>§saved: Option<SavedSnapshotRecord>§queued_frames: Option<u16>§dropped_frames: Option<u32>§filter_count: Option<u32>§host_channel_count: Option<u32>§host_peer_count: Option<u32>§auto_ack: Option<bool>§repeater: Option<UlcpRepeaterSettingsRecord>

Present when supports_repeater and the device reported the whole policy.

§dev_peer_keys: Option<Vec<Vec<u8>>>

PROP_DEV_PEERS: the peer public keys stored on the device identity, read back losslessly. Present when supports_device_identity and the device reported the list.

§dev_admin_keys: Option<Vec<Vec<u8>>>

PROP_DEV_ADMINS: the node public keys allowed to manage this device over the mesh, read back losslessly. Present when supports_admin and the device reported the list; an empty list is a device that nobody may manage remotely.

§dev_channel_ids: Option<Vec<Vec<u8>>>

PROP_DEV_CHANNEL_KEYS: the two-octet identifiers of the channels the device identity has joined. Key material is never read back, so a caller names these by deriving identifiers from the keys it holds; one that matches nothing locally is a channel the device knows and this phone does not.

§ident_role: Option<u8>

PROP_IDENT_ROLE. None covers “the device derives its role from what it is actually doing”, “no CAP_IDENT”, and “the device would not report it” — supports_ident and unreadable_properties distinguish them.

§ident_mobile: Option<bool>

PROP_IDENT_MOBILE. Present when supports_ident and the device reported it.

§ident_position: Option<UlcpIdentPositionRecord>

Where the device says it is. Present when supports_ident and the device reported its position; a device that advertises none reports an empty cell rather than nothing.

§dev_discoverable: Option<bool>

PROP_DEV_DISCOVERABLE: whether the device identity answers Identity Requests. Present when supports_device_identity and the device reported it.

§tz_offset_min: Option<i16>

PROP_TZ_OFFSET in minutes east of UTC. Present when supports_time and the device reported it.

The zone is configuration and the epoch is not: where a device is meant to be is known even when what time it is is not, which is why this is here and the clock reading is on the session snapshot.

§gnss: Option<UlcpGnssSettingsRecord>

The positioning policy. Present when supports_gnss and the device reported the whole of it.

§advert: Option<UlcpAdvertSettingsRecord>

The advertisement policy. Present when supports_advert and the device reported the whole of it.

§unreadable_properties: Vec<u32>

Capability-gated properties the device advertised but would not report, in ascending order.

A device that refuses a property — old firmware behind a newer capability, a property it never implemented — is a device with an unknown setting, not one this phone cannot administer. Their values are absent above, they are left out of configuration writes, and nothing about them can be verified after a save.

Trait Implementations§

Source§

impl Clone for UlcpSyncRecord

Source§

fn clone(&self) -> UlcpSyncRecord

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<UT> ConvertError<UT> for UlcpSyncRecord

Source§

impl Debug for UlcpSyncRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<UT> FfiConverter<UT> for UlcpSyncRecord

Source§

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.
Source§

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI. Read more
Source§

fn lower(v: Self) -> RustBuffer

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

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

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

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

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

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

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

impl<UT> Lift<UT> for UlcpSyncRecord

Source§

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

Source§

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

Source§

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

Source§

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

Convenience method
Source§

impl<UT> LiftRef<UT> for UlcpSyncRecord

Source§

impl<UT> LiftReturn<UT> for UlcpSyncRecord

Source§

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

FFI return type for trait interfaces
Source§

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

Lift a successfully returned value from a trait interface
Source§

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

Lift a foreign returned value from a trait interface Read more
Source§

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result Read more
Source§

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error Read more
Source§

impl<UT> Lower<UT> for UlcpSyncRecord

Source§

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

Source§

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

Source§

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

Source§

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method
Source§

impl<UT> LowerError<UT> for UlcpSyncRecord

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for UlcpSyncRecord

Source§

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

The type that should be returned by scaffolding functions for this type. Read more
Source§

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

Lower the return value from an scaffolding call Read more
Source§

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

Lower the return value for failed argument lifts Read more
Source§

impl PartialEq for UlcpSyncRecord

Source§

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

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

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

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

impl<UT> TypeId<UT> for UlcpSyncRecord

Source§

impl StructuralPartialEq for UlcpSyncRecord

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.