Struct Builder 

pub struct Builder { /* private fields */ }

Reads interface files and generates bindings for the interfaces in them.

Examples

tokio_dbus_codegen::Builder::new()
    .file("interfaces/org.kde.StatusNotifierItem.xml")
    .file("interfaces/com.canonical.dbusmenu.xml")
    .server("org.kde.StatusNotifierItem")
    .server("com.canonical.dbusmenu")
    .client("org.kde.StatusNotifierWatcher")
    .generate("systray.rs")?;

Implementations

impl Builder

pub fn new() -> Self

Construct an empty builder.

Examples found in repository

examples/dump.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let file = args.next().ok_or("Usage: dump <file.xml> <interface>...")?;
    let mut builder = tokio_dbus_codegen::Builder::new().file(file);

    for name in args {
        builder = builder.both(name);
    }

    print!("{}", builder.to_string()?);
    Ok(())
}

pub fn file(self, path: impl AsRef<Path>) -> Self

Read an interface file.

Every interface in the file becomes available to client(), server() and both(), including the ones in child nodes.

Examples found in repository

examples/dump.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let file = args.next().ok_or("Usage: dump <file.xml> <interface>...")?;
    let mut builder = tokio_dbus_codegen::Builder::new().file(file);

    for name in args {
        builder = builder.both(name);
    }

    print!("{}", builder.to_string()?);
    Ok(())
}

pub fn client(self, interface: impl AsRef<str>) -> Self

Generate an asynchronous client for the named interface.

pub fn server(self, interface: impl AsRef<str>) -> Self

Generate a server trait and dispatcher for the named interface.

pub fn both(self, interface: impl AsRef<str>) -> Self

Generate both a client and a server for the named interface.

Examples found in repository

examples/dump.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let file = args.next().ok_or("Usage: dump <file.xml> <interface>...")?;
    let mut builder = tokio_dbus_codegen::Builder::new().file(file);

    for name in args {
        builder = builder.both(name);
    }

    print!("{}", builder.to_string()?);
    Ok(())
}

pub fn generate(self, name: impl AsRef<Path>) -> Result<PathBuf>

Generate into $OUT_DIR/<name>, which is where a build script should put it.

This also emits a cargo::rerun-if-changed line for every interface file which was read.

pub fn write_to(self, path: impl AsRef<Path>) -> Result<()>

Generate into an explicit path.

pub fn to_string(&self) -> Result<String>

Generate the bindings and return them as a string.

This is what generate() and write_to() use, and is useful for inspecting the output in a test.

Examples found in repository

examples/dump.rs (line 17)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let file = args.next().ok_or("Usage: dump <file.xml> <interface>...")?;
    let mut builder = tokio_dbus_codegen::Builder::new().file(file);

    for name in args {
        builder = builder.both(name);
    }

    print!("{}", builder.to_string()?);
    Ok(())
}

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.