Struct zbus::ConnectionBuilder

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

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.

pub fn unix_stream(stream: UnixStream) -> Self

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

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

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

pub fn p2p(self) -> Self

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

Note: When using zbus::ObjectServer with a p2p connection, you must explicitly start the dispatch process by calling zbus::ObjectServer::start_dispatch.

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

The to-be-created connection will a be 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 max number of messages to 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 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.