Struct lapin_async::connection::Connection

pub struct Connection {
    pub state: ConnectionState,
    pub channels: Channels,
    pub configuration: Configuration,
    pub vhost: String,
    // some fields omitted
}

Fields

state: ConnectionState

current state of the connection. In normal use it should always be ConnectionState::Connected

channels: Channels

configuration: Configuration

vhost: String

Methods

impl Connection

pub fn new() -> Self

creates a Connection object in initial state

pub fn set_credentials(&mut self, username: &str, password: &str)

pub fn set_vhost(&mut self, vhost: &str)

pub fn connect(
    &mut self,
    options: ConnectionProperties
) -> Result<ConnectionState>

starts the process of connecting to the server

this will set up the state machine and generates the required messages. The messages will not be sent until calls to serialize to write the messages to a buffer, or calls to next_frame to obtain the next message to send

pub fn next_frame(&mut self) -> Option<AMQPFrame>

next message to send to the network

returns None if there's no message to send

pub fn serialize(
    &mut self,
    send_buffer: &mut [u8]
) -> Result<(usize, ConnectionState)>

writes the next message to a mutable byte slice

returns how many bytes were written and the current state. this method can be called repeatedly until the buffer is full or there are no more frames to send

pub fn parse(&mut self, data: &[u8]) -> Result<(usize, ConnectionState)>

parses a frame from a byte slice

returns how many bytes were consumed and the current state.

This method will update the state machine according to the ReceivedStart frame with handle_frame

pub fn handle_frame(&mut self, f: AMQPFrame) -> Result<(), Error>

updates the current state with a new received frame

impl Connection

pub fn run<T: Read + Write>(
    &mut self,
    stream: &mut T,
    send_buffer: &mut Buffer,
    receive_buffer: &mut Buffer
) -> Result<ConnectionState>

helper function to handle reading and writing repeatedly from the network until there's no more state to update

Trait Implementations

impl Default for Connection

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Connection

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

Formats the value using the given formatter.