Struct zbus::handshake::ClientHandshake

pub struct ClientHandshake<S> { /* fields omitted */ }

A representation of an in-progress handshake, client-side

This struct is an async-compatible representation of the initial handshake that must be performed before a D-Bus connection can be used. To use it, you should call the advance_handshake method whenever the underlying socket becomes ready (tracking the readiness itself is not managed by this abstraction) until it returns Ok(()), at which point you can invoke the try_finish method to get an Authenticated, which can be given to Connection::new_authenticated.

If handling the handshake asynchronously is not necessary, the blocking_finish method is provided which blocks until the handshake is completed or an error occurs.

Implementations

impl<S: Socket> ClientHandshake<S>

pub fn new(socket: S) -> ClientHandshake<S>

Start a handsake on this client socket

pub fn advance_handshake(&mut self) -> Result<()>

Same as Handshake::advance_handshake. Only exists for backwards compatibility.

pub fn try_finish(self) -> Result<Authenticated<S>, Self>

Same as Handshake::try_finish. Only exists for backwards compatibility.

pub fn socket(&self) -> &S

Same as Handshake::socket. Only exists for backwards compatibility.

impl ClientHandshake<UnixStream>

pub fn new_session() -> Result<Self>

Initialize a handshake to the session/user message bus.

The socket backing this connection is created in blocking mode.

pub fn new_session_nonblock() -> Result<Self>

Initialize a handshake to the session/user message bus.

The socket backing this connection is created in non-blocking mode.

pub fn new_system() -> Result<Self>

Initialize a handshake to the system-wide message bus.

The socket backing this connection is created in blocking mode.

pub fn new_system_nonblock() -> Result<Self>

Initialize a handshake to the system-wide message bus.

The socket backing this connection is created in non-blocking mode.

pub fn new_for_address(address: &str) -> Result<Self>

Create a handshake for the given D-Bus address.

The socket backing this connection is created in blocking mode.

pub fn new_for_address_nonblock(address: &str) -> Result<Self>

Create a handshake for the given D-Bus address.

The socket backing this connection is created in non-blocking mode.

pub fn blocking_finish(self) -> Result<Authenticated<UnixStream>>

Block and automatically drive the handshake for this client

This method will block until the handshake is finalized, even if the socket is in non-blocking mode.

Trait Implementations

impl<S: Debug> Debug for ClientHandshake<S>

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

Formats the value using the given formatter.

impl<S: Socket> Handshake<S> for ClientHandshake<S>

pub fn next_io_operation(&self) -> IoOperation

The next I/O operation needed for advancing the handshake.

pub fn advance_handshake(&mut self) -> Result<()>

Attempt to advance the handshake

pub fn try_finish(self) -> Result<Authenticated<S>, Self>

Attempt to finalize this handshake into an initialized client.

pub fn socket(&self) -> &S

Access the socket backing this handshake