Struct NetconfCodec 

pub struct NetconfCodec { /* private fields */ }

Implementations

impl NetconfCodec

tokio_util codec for NETCONF message framing.

Implements the Decoder trait from tokio_util, which defines how to extract discrete messages from a continuous TCP byte stream.

We don’t call decode() directly. Instead, we pass this codec to FramedRead, which handles the I/O loop:

let reader = FramedRead::new(read_half, NetconfCodec::new(…)); while let Some(msg) = reader.next().await { … }

FramedRead reads bytes from the network into an internal buffer, calls our decode() to check for a complete message, and yields messages as a Stream. We only need to implement the framing logic – “is there a complete message in this buffer?” – and FramedRead handles everything else (buffer management, read loops, EOF).

decode() is called repeatedly. It owns the internal buffer. When decode() returns Ok(None), FramedRead reads more bytes from the underlying AsyncRead into the buffer and calls decode() again. When decode() returns Ok(Some(item)), the item is yielded to the consumer. The key invariant is: decode() must consume (via split_to() or advance()) exactly the bytes belonging to the returned message. Any leftover bytes in src remain for the next decode() call.

Returns Bytes (not String) because UTF-8 validation is deferred to the XML parser. This avoids a redundant O(n) validation pass at the framing layer

pub fn new(framing_mode: FramingMode, config: CodecConfig) -> Self

pub fn set_mode(&mut self, framing_mode: FramingMode)

pub fn framing_mode(&self) -> FramingMode

Trait Implementations

impl Decoder for NetconfCodec

https://docs.rs/tokio-util/latest/tokio_util/codec/trait.Decoder.html

type Item = Bytes

The type of decoded frames.

type Error = FramingError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Encoder<Bytes> for NetconfCodec

type Error = FramingError

The type of encoding errors.

fn encode(&mut self, item: Bytes, dst: &mut BytesMut) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.