Struct dbus_crossroads::IfaceBuilder

pub struct IfaceBuilder<T: Send + 'static>(_, _);

Struct used to build an interface.

You get an instance of this struct in the call to Crossroads::register.

Register new methods, properties and signals using the corresponding functions on this struct. You might find several similar functions, e g method, method_with_cr, method_with_cr_async and method_with_cr_custom. Methods that have “with_cr” will allow you to access the full mutable Crossroads instance, but beware - trying to recursively handle methods from within a method handler is not allowed and may cause panics.

Methods that have “_async” will allow you to defer the result of your method. During await points, other tasks with method calls can run as separate tasks. Remember to call Crossroads::set_async_support when using async methods.

Implementations

impl<T: Send + 'static> IfaceBuilder<T>

pub fn property<A: Arg, N: Into<String>>(
    &mut self,
    name: N
) -> PropBuilder<'_, T, A>

pub fn method<IA, OA, N, CB>(
    &mut self,
    name: N,
    input_args: IA::strs,
    output_args: OA::strs,
    cb: CB
) -> &mut MethodDescwhere
    IA: ArgAll + ReadAll,
    OA: ArgAll + AppendAll,
    N: Into<Member<'static>>,
    CB: FnMut(&mut Context, &mut T, IA) -> Result<OA, MethodErr> + Send + 'static,

pub fn method_with_cr<IA, OA, N, CB>(
    &mut self,
    name: N,
    input_args: IA::strs,
    output_args: OA::strs,
    cb: CB
) -> &mut MethodDescwhere
    IA: ArgAll + ReadAll,
    OA: ArgAll + AppendAll,
    N: Into<Member<'static>>,
    CB: FnMut(&mut Context, &mut Crossroads, IA) -> Result<OA, MethodErr> + Send + 'static,

pub fn method_with_cr_custom<IA, OA, N, CB>(
    &mut self,
    name: N,
    input_args: IA::strs,
    output_args: OA::strs,
    cb: CB
) -> &mut MethodDescwhere
    IA: ArgAll + ReadAll,
    OA: ArgAll + AppendAll,
    N: Into<Member<'static>>,
    CB: FnMut(Context, &mut Crossroads, IA) -> Option<Context> + Send + 'static,

pub fn method_with_cr_async<IA, OA, N, R, CB>(
    &mut self,
    name: N,
    input_args: IA::strs,
    output_args: OA::strs,
    cb: CB
) -> &mut MethodDescwhere
    IA: ArgAll + ReadAll,
    OA: ArgAll + AppendAll,
    N: Into<Member<'static>>,
    CB: FnMut(Context, &mut Crossroads, IA) -> R + Send + 'static,
    R: Future<Output = PhantomData<OA>> + Send + 'static,

pub fn signal<A, N>(&mut self, name: N, args: A::strs) -> SignalBuilder<'_, A>where
    A: ArgAll,
    N: Into<Member<'static>>,

pub fn annotate<N: Into<String>, V: Into<String>>(
    &mut self,
    name: N,
    value: V
) -> &mut Self

pub fn deprecated(&mut self) -> &mut Self

Trait Implementations

impl<T: Debug + Send + 'static> Debug for IfaceBuilder<T>

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

Formats the value using the given formatter.