Struct Method

pub struct Method<M: MethodType<D>, D: DataType> { /* private fields */ }

A D-Bus Method.

Implementations

impl<M: MethodType<D>, D: DataType> Method<M, D>

pub fn in_arg<A: Into<Argument>>(self, a: A) -> Self

Builder method that adds an “in” Argument to this Method.

pub fn inarg<A: Arg, S: Into<String>>(self, s: S) -> Self

Builder method that adds an “in” Argument to this Method.

Examples found in repository

examples/server.rs (line 56)

fn main() -> Result<(), Box<dyn Error>> {
    // Let's start by starting up a connection to the session bus and request a name.
    let c = LocalConnection::new_session()?;
    c.request_name("com.example.dbustest", false, true, false)?;

    // The choice of factory tells us what type of tree we want,
    // and if we want any extra data inside. We pick the simplest variant.
    let f = Factory::new_fn::<()>();

    // We create the signal first, since we'll need it in both inside the method callback
    // and when creating the tree.
    let signal = Arc::new(f.signal("HelloHappened", ()).sarg::<&str,_>("sender"));
    let signal2 = signal.clone();

    // We create a tree with one object path inside and make that path introspectable.
    let tree = f.tree(()).add(f.object_path("/hello", ()).introspectable().add(

        // We add an interface to the object path...
        f.interface("com.example.dbustest", ()).add_m(

            // ...and a method inside the interface.
            f.method("Hello", (), move |m| {

                // This is the callback that will be called when another peer on the bus calls our method.
                // the callback receives "MethodInfo" struct and can return either an error, or a list of
                // messages to send back.

                let name: &str = m.msg.read1()?;
                let s = format!("Hello {}!", name);
                let mret = m.msg.method_return().append1(s);

                let sig = signal.msg(m.path.get_name(), m.iface.get_name())
                    .append1(&*name);

                // Two messages will be returned - one is the method return (and should always be there),
                // and in our case we also have a signal we want to send at the same time.
                Ok(vec!(mret, sig))

            // Our method has one output argument and one input argument.
            }).outarg::<&str,_>("reply")
            .inarg::<&str,_>("name")

        // We also add the signal to the interface. This is mainly for introspection.
        ).add_s(signal2)

    // Also add the root path, to help introspection from debugging tools.
    )).add(f.object_path("/", ()).introspectable());

    // We add the tree to the connection so that incoming method calls will be handled.
    tree.start_receive(&c);

    // Serve clients forever.
    loop { c.process(Duration::from_millis(1000))?; }
}

pub fn in_args<Z: Into<Argument>, A: IntoIterator<Item = Z>>(self, a: A) -> Self

Builder method that adds multiple “in” Arguments to this Method.

pub fn out_arg<A: Into<Argument>>(self, a: A) -> Self

Builder method that adds an “out” Argument to this Method.

pub fn outarg<A: Arg, S: Into<String>>(self, s: S) -> Self

Builder method that adds an “out” Argument to this Method.

Examples found in repository

examples/server.rs (line 55)

fn main() -> Result<(), Box<dyn Error>> {
    // Let's start by starting up a connection to the session bus and request a name.
    let c = LocalConnection::new_session()?;
    c.request_name("com.example.dbustest", false, true, false)?;

    // The choice of factory tells us what type of tree we want,
    // and if we want any extra data inside. We pick the simplest variant.
    let f = Factory::new_fn::<()>();

    // We create the signal first, since we'll need it in both inside the method callback
    // and when creating the tree.
    let signal = Arc::new(f.signal("HelloHappened", ()).sarg::<&str,_>("sender"));
    let signal2 = signal.clone();

    // We create a tree with one object path inside and make that path introspectable.
    let tree = f.tree(()).add(f.object_path("/hello", ()).introspectable().add(

        // We add an interface to the object path...
        f.interface("com.example.dbustest", ()).add_m(

            // ...and a method inside the interface.
            f.method("Hello", (), move |m| {

                // This is the callback that will be called when another peer on the bus calls our method.
                // the callback receives "MethodInfo" struct and can return either an error, or a list of
                // messages to send back.

                let name: &str = m.msg.read1()?;
                let s = format!("Hello {}!", name);
                let mret = m.msg.method_return().append1(s);

                let sig = signal.msg(m.path.get_name(), m.iface.get_name())
                    .append1(&*name);

                // Two messages will be returned - one is the method return (and should always be there),
                // and in our case we also have a signal we want to send at the same time.
                Ok(vec!(mret, sig))

            // Our method has one output argument and one input argument.
            }).outarg::<&str,_>("reply")
            .inarg::<&str,_>("name")

        // We also add the signal to the interface. This is mainly for introspection.
        ).add_s(signal2)

    // Also add the root path, to help introspection from debugging tools.
    )).add(f.object_path("/", ()).introspectable());

    // We add the tree to the connection so that incoming method calls will be handled.
    tree.start_receive(&c);

    // Serve clients forever.
    loop { c.process(Duration::from_millis(1000))?; }
}

pub fn out_args<Z: Into<Argument>, A: IntoIterator<Item = Z>>( self, a: A, ) -> Self

Builder method that adds multiple “out” Arguments to this Method.

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

Builder method that adds an annotation to the method.

pub fn deprecated(self) -> Self

Builder method that adds an annotation that this entity is deprecated.

pub fn call(&self, minfo: &MethodInfo<'_, M, D>) -> MethodResult

Call the Method

pub fn get_name(&self) -> &Member<'static>

Get method name

pub fn get_data(&self) -> &D::Method

Get associated data

Trait Implementations

impl<M: Debug + MethodType<D>, D: Debug + DataType> Debug for Method<M, D>

where D::Method: Debug,

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

Formats the value using the given formatter.