Struct RiDevice 

pub struct RiDevice { /* private fields */ }

Smart device representation

This struct represents a smart device in the Ri system, including its status, capabilities, health metrics, and lifecycle information.

Implementations

impl RiDevice

pub fn new(name: String, device_type: RiDeviceType) -> Self

Creates a new device with the given name and type

Parameters

• name: The name of the device
• device_type: The type of the device

Returns

A new RiDevice instance with default capabilities and health metrics

pub fn id(&self) -> &str

Gets the device ID

Returns

The device ID as a string slice

pub fn name(&self) -> &str

Gets the device name

Returns

The device name as a string slice

pub fn device_type(&self) -> RiDeviceType

Gets the device type

Returns

The device type as a RiDeviceType enum

pub fn status(&self) -> RiDeviceStatus

Gets the current device status

Returns

The device status as a RiDeviceStatus enum

pub fn capabilities(&self) -> &RiDeviceCapabilities

Gets a reference to the device capabilities

Returns

A reference to the RiDeviceCapabilities structure

pub fn health_metrics(&self) -> &RiDeviceHealthMetrics

Gets a reference to the device health metrics

Returns

A reference to the RiDeviceHealthMetrics structure

pub fn set_status(&mut self, status: RiDeviceStatus)

Sets the device status and updates the last seen timestamp

Parameters

• status: The new status to set

pub fn update_health_metrics(&mut self, metrics: RiDeviceHealthMetrics)

Updates the device health metrics and last seen timestamp

Parameters

• metrics: The new health metrics to set

pub fn increment_error_count(&mut self)

Increments the device error count and updates the last seen timestamp

pub fn update_throughput(&mut self, throughput: u64)

Updates the device throughput and last seen timestamp

Parameters

• throughput: The new throughput value in operations per second

pub fn with_capabilities(self, capabilities: RiDeviceCapabilities) -> Self

Sets the device capabilities using the builder pattern

Parameters

• capabilities: The new capabilities to set

Returns

The updated RiDevice instance

pub fn set_location(&mut self, location: String)

Sets the device location

Parameters

• location: The physical location of the device

pub fn add_metadata(&mut self, key: String, value: String)

Adds a metadata key-value pair to the device

Parameters

• key: Metadata key
• value: Metadata value

pub fn update_last_seen(&mut self)

Updates the last seen timestamp to the current time

pub fn last_seen(&self) -> DateTime<Utc>

Gets the last seen timestamp

Returns

The last seen timestamp as a chrono::DateTime<chrono::Utc>

pub fn is_available(&self) -> bool

Checks if the device is available for allocation

A device is available if its status is Available and it has no current allocation.

Returns

true if the device is available, false otherwise

pub fn is_allocated(&self) -> bool

Checks if the device is currently allocated

Returns

true if the device is allocated, false otherwise

pub fn allocate(&mut self, allocation_id: &str) -> bool

Allocates the device to a specific allocation ID

This method marks the device as busy and associates it with the given allocation ID.

Parameters

• allocation_id: The ID of the allocation using this device

Returns

true if the device was successfully allocated, false if it was already in use

pub fn release(&mut self)

Releases the device from its current allocation

This method clears the allocation ID and sets the device status to Available if it was Busy.

pub fn group(&self) -> Option<&str>

Gets the device group

Returns

The device group as an Option<&str>

pub fn set_group(&mut self, group: Option<String>)

Sets the device group

Parameters

• group: The new group for the device

pub fn tags(&self) -> &Vec<String>

Gets the device tags

Returns

A reference to the device tags vector

pub fn add_tag(&mut self, tag: String)

Adds a tag to the device

Parameters

• tag: The tag to add to the device

pub fn remove_tag(&mut self, tag: &str) -> bool

Removes a tag from the device

Parameters

• tag: The tag to remove from the device

Returns

true if the tag was removed, false if the tag was not found

pub fn has_tag(&self, tag: &str) -> bool

Checks if the device has a specific tag

Parameters

• tag: The tag to check for

Returns

true if the device has the tag, false otherwise

pub fn get_allocation_id(&self) -> Option<&str>

Gets the current allocation ID if the device is allocated

Returns

An Option<&str> containing the allocation ID if the device is allocated, None otherwise

pub fn health_score(&self) -> u8

Calculates a simple health score based on device status (0-100)

This method returns a basic health score based solely on the device status.

Returns

A health score between 0 (worst) and 100 (best)

pub fn is_responsive(&self, timeout_secs: i64) -> bool

Checks if the device is still responsive (last seen within the timeout)

Parameters

• timeout_secs: Maximum number of seconds since last seen for the device to be considered responsive

Returns

true if the device is responsive, false otherwise

pub fn dynamic_health_score(&self, health_metrics: &RiDeviceHealthMetrics) -> u8

Calculates a dynamic health score based on multiple factors (0-100)

This method calculates a comprehensive health score based on device status, CPU usage, memory usage, temperature, and error count.

Parameters

• health_metrics: Current health metrics for the device

Returns

A dynamic health score between 0 (worst) and 100 (best)

pub fn is_healthy( &self, health_metrics: &RiDeviceHealthMetrics, timeout_secs: i64, ) -> bool

Checks if the device is healthy based on multiple criteria

A device is considered healthy if it is responsive, has a good health score, and is not in an error or offline state.

Parameters

• health_metrics: Current health metrics for the device
• timeout_secs: Maximum number of seconds since last seen for the device to be considered responsive

Returns

true if the device is healthy, false otherwise

pub fn metadata(&self) -> &HashMap<String, String>

Gets a reference to the device metadata

Returns

A reference to the metadata HashMap

Trait Implementations

impl Clone for RiDevice

fn clone(&self) -> RiDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiDevice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RiDevice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for RiDevice

type Target = RiDevice

The Python output type

type Output = Bound<'py, <RiDevice as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiDevice

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiDevice

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Smart device representation\n\nThis struct represents a smart device in the Ri system, including its status, capabilities,\nhealth metrics, and lifecycle information.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiDevice>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiDevice

const TEXT_SIGNATURE: &'static str = "(name, device_type)"

impl PyMethods<RiDevice> for PyClassImplCollector<RiDevice>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiDevice

const NAME: &'static str = "RiDevice"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for RiDevice

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for RiDevice

impl ExtractPyClassWithClone for RiDevice