Struct Channel 

pub struct Channel {
    pub opened: bool,
    pub setup: bool,
    pub initiator: bool,
    pub closed: bool,
    pub xml_reader: XmlReader,
    pub outbox: VecDeque<Vec<u8>>,
}

Communication channel between nodes in the propagation tree.

A Channel manages XML-based message exchange over a transport (typically an SSH pipe). It uses an XmlReader for incoming messages and XML generation for outgoing messages.

Fields

opened: bool

Whether the channel has been opened (received StartMessage).

setup: bool

Whether the channel setup is complete (received ACK to config).

initiator: bool

Whether this end initiated the channel.

closed: bool

Whether the channel has been closed (fatal error or EndMessage).

xml_reader: XmlReader

The XML reader for parsing incoming data.

outbox: VecDeque<Vec<u8>>

Outgoing message buffer.

Implementations

impl Channel

pub fn new(initiator: bool) -> Self

Create a new Channel.

Arguments

• initiator - true if this end is initiating the channel

pub fn init_xml(&self) -> Vec<u8>

Generate the XML document header.

pub fn open_xml(&self, version: &str) -> Vec<u8>

Generate the opening <channel> tag.

pub fn close_xml(&self) -> Vec<u8>

Generate the closing </channel> tag.

pub fn send(&mut self, msg: &Message)

Serialize a message and enqueue it for sending.

pub fn feed( &mut self, data: &str, ) -> Result<Vec<Message>, MessageProcessingError>

Feed incoming data to the XML reader and return any parsed messages.

pub fn take_outgoing(&mut self) -> Option<Vec<u8>>

Take the next outgoing message from the outbox.

pub fn close(&mut self)

Mark the channel as closed (mirrors upstream Channel._close).

pub fn handle_channel_error( &mut self, node: &str, err: &MessageProcessingError, ) -> Option<Message>

Report a channel-level error, mirroring upstream Channel.ev_read’s SAXParseException / MessageProcessingError handlers (commit 6f45bf5).

• initiator side: returns a synthetic stderr Message (ident SER, srcid 0, nodes = node) whose payload is the error text encoded with ENCODING. Upstream passes bytes here; passing the error text through unchanged (instead of a str/bytes mix) is what fixed the TypeError that hid the original error. The caller delivers the returned message to its own recv() path, exactly like upstream’s self.recv(StdErrMessage(node, text.encode(ENCODING))). For a parse error the bare parser message is used (upstream sends ex.getMessage(), e.g. “not well-formed (invalid token)”).
• target side: enqueues an Error message back to the peer (“Parse error: %s” for parse errors, the plain error text otherwise) and returns None.

In both cases the channel is closed: upstream treats these as fatal channel errors. This function is infallible — the error-reporting path must never itself fail (6f45bf5).

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.