Struct aldrin::Object

pub struct Object { /* private fields */ }

Owned object on the bus.

Objects are created with Handle::create_object and exist until either manually destroyed or dropped. When an Object is destroyed, all associated Services will be destroyed as well. At runtime, every valid Object is uniquely identified by an ObjectId on the bus.

Object holds an internal Handle and will thus prevent the Client from shutting down automatically. The Handle is released when the Object is dropped.

Examples

use aldrin::core::ObjectUuid;
use uuid::uuid;

const OBJECT2_UUID: ObjectUuid = ObjectUuid(uuid!("6173e119-8066-4776-989b-145a5f16ed4c"));

// Create an object with a random UUID:
let object1 = handle.create_object(ObjectUuid::new_v4()).await?;

// Destroy object1 explicitly:
object1.destroy().await?;

{
    // Create an object with a fixed UUID:
    let object2 = handle.create_object(OBJECT2_UUID).await?;

    // object2 is destroyed implicitly when it falls out of scope and is dropped.
}

Implementations

impl Object

pub fn id(&self) -> ObjectId

Returns the id of the object.

pub fn handle(&self) -> &Handle

Returns a handle to the client that was used to create the object.

pub async fn destroy(&self) -> Result<(), Error>

Destroys the object.

If the object has already been destroyed, Error::InvalidObject is returned.

pub async fn create_service( &self, uuid: impl Into<ServiceUuid>, version: u32 ) -> Result<Service, Error>

Creates a service on the object.

The uuid must not yet exists on this Object, or else Error::DuplicateService will be returned.

Examples

use aldrin::Error;
use aldrin::core::{ObjectUuid, ServiceUuid};
use uuid::uuid;

const MY_SERVICE_UUID: ServiceUuid = ServiceUuid(uuid!("800b47a1-3882-4601-9155-e18c654476cc"));

let object = handle.create_object(ObjectUuid::new_v4()).await?;

// Create a service:
let service = object.create_service(MY_SERVICE_UUID, 0).await?;

// Trying to create the same service on the same object again will cause an error:
assert_eq!(
    object.create_service(MY_SERVICE_UUID, 0).await.unwrap_err(),
    Error::DuplicateService,
);

Trait Implementations

impl Debug for Object

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

Formats the value using the given formatter.

impl Drop for Object

fn drop(&mut self)

Executes the destructor for this type.