Struct NetconfCodec 

pub struct NetconfCodec { /* private fields */ }

Implementations

impl NetconfCodec

tokio_util codec for NETCONF message framing.

Implements the Decoder trait from tokio_util. Instead of returning complete messages, the decoder yields DecodedFrame items: individual Chunks as data arrives, followed by EndOfMessage when the message boundary is reached.

This chunk-level output enables the reader task to route messages without buffering: normal RPCs accumulate chunks into a BytesMut, while streaming RPCs forward each chunk directly to the consumer.

The Encoder side is unchanged — it frames complete XML documents with the appropriate delimiter/chunking.

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

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

pub fn framing_mode(&self) -> FramingMode

pub fn set_closing(&mut self)

Mark the codec as closing so that decode_eof silently discards leftover holdback bytes instead of treating them as an error.

Trait Implementations

impl Decoder for NetconfCodec

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

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

Handle EOF from the underlying transport.

When closing is set (a close-session RPC is in flight), leftover holdback bytes are harmless artifacts of the EOM split-marker guard and are silently discarded. Otherwise we fall back to the default behaviour: any remaining bytes at EOF indicate a transport problem.

type Item = DecodedFrame

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 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.