Struct zbus::blocking::object_server::InterfaceRef

source ·
pub struct InterfaceRef<I> { /* private fields */ }
Expand description

Wrapper over an interface, along with its corresponding SignalContext instance. A reference to the underlying interface may be obtained via InterfaceRef::get and InterfaceRef::get_mut.

Implementations§

source§

impl<I> InterfaceRef<I>
where I: 'static,

source

pub fn get(&self) -> InterfaceDeref<'_, I>

Get a reference to the underlying interface.

source

pub fn get_mut(&self) -> InterfaceDerefMut<'_, I>

Get a reference to the underlying interface.

WARNINGS: Since the ObjectServer will not be able to access the interface in question until the return value of this method is dropped, it is highly recommended that the scope of the interface returned is restricted.

§Errors

If the interface at this instance’s path is not valid, Error::InterfaceNotFound error is returned.

§Examples

struct MyIface(u32);

#[interface(name = "org.myiface.MyIface")]
impl MyIface {
   #[zbus(property)]
   fn count(&self) -> u32 {
       self.0
   }
}
// Setup connection and object_server etc here and then in another part of the code:
let object_server = connection.object_server();
let iface_ref = object_server.interface::<_, MyIface>(path)?;
let mut iface = iface_ref.get_mut();
iface.0 = 42;
block_on(iface.count_changed(iface_ref.signal_context()))?;
source

pub fn signal_context(&self) -> &SignalContext<'static>

Auto Trait Implementations§

§

impl<I> Freeze for InterfaceRef<I>

§

impl<I> !RefUnwindSafe for InterfaceRef<I>

§

impl<I> Send for InterfaceRef<I>
where I: Send,

§

impl<I> Sync for InterfaceRef<I>
where I: Sync,

§

impl<I> Unpin for InterfaceRef<I>
where I: Unpin,

§

impl<I> !UnwindSafe for InterfaceRef<I>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

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

§

type Output = T

Should always be Self
source§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more