Struct RelayCellDecoderResult

pub struct RelayCellDecoderResult { /* private fields */ }

Result of calling RelayCellDecoder::decode.

Implementations

impl RelayCellDecoderResult

pub fn cmds(&self) -> impl Iterator<Item = RelayCmd> + '_

Returns a non-empty iterator over commands in relay messages that the cell producing this result contained any part of. i.e. this includes the command of “head”, “middle”, and/or “tail” message fragments that were in the cell.

pub fn into_parts( self, ) -> (impl Iterator<Item = UnparsedRelayMsg>, Option<IncompleteRelayMsgInfo>)

Converts self to an iterator over the complete messages, and metadata about the trailing incomplete message (as for Self::incomplete_info), if any.

pub fn incomplete_info(&self) -> Option<IncompleteRelayMsgInfo>

Returns the IncompleteRelayMsgInfo describing the incomplete relay message that this cell contained a fragment of, if any.

Note that:

• This does not describe a fragment that includes the end of the relay message, since the message is then complete.
• This does include a fragment that continues, but does not complete, a message started in an earlier relay cell.
• There is at most one such incomplete relay message, since no current relay cell format supports starting a new message before completing the previous one.

Trait Implementations

impl Debug for RelayCellDecoderResult

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

Formats the value using the given formatter.