Struct zbus::ConnectionBuilder

pub struct ConnectionBuilder<'a> { /* private fields */ }

A builder for zbus::Connection.

Implementations

impl<'a> ConnectionBuilder<'a>

pub fn session() -> Result<Self>

Create a builder for the session/user message bus connection.

pub fn system() -> Result<Self>

Create a builder for the system-wide message bus connection.

pub fn address<A>(address: A) -> Result<Self>

where A: TryInto<Address>, A::Error: Into<Error>,

Create a builder for connection that will use the given D-Bus bus address.

Example

Here is an example of connecting to an IBus service:

let addr = "unix:\
    path=/home/zeenix/.cache/ibus/dbus-ET0Xzrk9,\
    guid=fdd08e811a6c7ebe1fef0d9e647230da";
let conn = ConnectionBuilder::address(addr)?
    .build()
    .await?;

// Do something useful with `conn`..

Note: The IBus address is different for each session. You can find the address for your current session using ibus address command.

pub fn unix_stream(stream: UnixStream) -> Self

Create a builder for connection that will use the given unix stream.

If the default async-io feature is disabled, this method will expect tokio::net::UnixStream argument.

pub fn tcp_stream(stream: TcpStream) -> Self

Create a builder for connection that will use the given TCP stream.

If the default async-io feature is disabled, this method will expect tokio::net::TcpStream argument.

pub fn socket<S: Socket + 'static>(socket: S) -> Self

Create a builder for connection that will use the given socket.

pub fn auth_mechanisms(self, auth_mechanisms: &[AuthMechanism]) -> Self

Specify the mechanisms to use during authentication.

pub fn cookie_context<C>(self, context: C) -> Result<Self>

where C: Into<Str<'a>>,

The cookie context to use during authentication.

This is only used when the cookie authentication mechanism is enabled and only valid for server connection.

If not specified, the default cookie context of org_freedesktop_general will be used.

Errors

If the given string is not a valid cookie context.

pub fn cookie_id(self, id: usize) -> Self

The ID of the cookie to use during authentication.

This is only used when the cookie authentication mechanism is enabled and only valid for server connection.

If not specified, the first cookie found in the cookie context file will be used.

pub fn p2p(self) -> Self

The to-be-created connection will be a peer-to-peer connection.

pub fn server(self, guid: &'a Guid) -> Self

The to-be-created connection will be a server using the given GUID.

The to-be-created connection will wait for incoming client authentication handshake and negotiation messages, for peer-to-peer communications after successful creation.

pub fn max_queued(self, max: usize) -> Self

Set the capacity of the main (unfiltered) queue.

Since typically you’d want to set this at instantiation time, you can set it through the builder.

Example

let conn = ConnectionBuilder::session()?
    .max_queued(30)
    .build()
    .await?;
assert_eq!(conn.max_queued(), 30);

// Do something useful with `conn`..

pub fn internal_executor(self, enabled: bool) -> Self

Enable or disable the internal executor thread.

The thread is enabled by default.

See Connection::executor for more details.

pub fn serve_at<P, I>(self, path: P, iface: I) -> Result<Self>

where I: Interface, P: TryInto<ObjectPath<'a>>, P::Error: Into<Error>,

Register a D-Bus Interface to be served at a given path.

This is similar to zbus::ObjectServer::at, except that it allows you to have your interfaces available immediately after the connection is established. Typically, this is exactly what you’d want. Also in contrast to zbus::ObjectServer::at, this method will replace any previously added interface with the same name at the same path.

pub fn name<W>(self, well_known_name: W) -> Result<Self>

where W: TryInto<WellKnownName<'a>>, W::Error: Into<Error>,

Register a well-known name for this connection on the bus.

This is similar to zbus::Connection::request_name, except the name is requested as part of the connection setup (ConnectionBuilder::build), immediately after interfaces registered (through ConnectionBuilder::serve_at) are advertised. Typically this is exactly what you want.

pub fn unique_name<U>(self, unique_name: U) -> Result<Self>

where U: TryInto<UniqueName<'a>>, U::Error: Into<Error>,

Sets the unique name of the connection.

Panics

This method panics if the to-be-created connection is not a peer-to-peer connection. It will always panic if the connection is to a message bus as it’s the bus that assigns peers their unique names. This is mainly provided for bus implementations. All other users should not need to use this method.

pub async fn build(self) -> Result<Connection>

Build the connection, consuming the builder.

Errors

Until server-side bus connection is supported, attempting to build such a connection will result in Error::Unsupported error.

Trait Implementations

impl<'a> Debug for ConnectionBuilder<'a>

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

Formats the value using the given formatter.