Skip to main content

PeerMessageCodec

Struct PeerMessageCodec 

Source
pub struct PeerMessageCodec { /* private fields */ }
Expand description

Length-delimited message codec with optional CRC32 integrity checking.

§Example

use ipfrs_network::message_codec::{PeerMessageCodec, CodecConfig};

let codec = PeerMessageCodec::new(CodecConfig::default());
let wire = codec.encode(b"hello").expect("encode");
let payload = codec.decode(&wire).expect("decode");
assert_eq!(payload, b"hello");

Implementations§

Source§

impl PeerMessageCodec

Source

pub fn new(config: CodecConfig) -> Self

Create a new codec with the given configuration.

Source

pub fn encode(&self, payload: &[u8]) -> Result<Vec<u8>, CodecError>

Encode a payload into wire format.

Returns the complete frame: [4-byte length BE][payload][optional 4-byte CRC32].

§Errors

Returns CodecError::MessageTooLarge if payload.len() exceeds config.max_message_size.

Source

pub fn encode_with_metadata( &self, payload: &[u8], ) -> Result<EncodedMessage, CodecError>

Encode a payload and return an EncodedMessage with metadata.

Source

pub fn decode(&self, data: &[u8]) -> Result<Vec<u8>, CodecError>

Decode a wire-format frame and return the payload bytes.

§Errors
Source

pub fn crc32(data: &[u8]) -> u32

Compute a CRC32 checksum (IEEE / ISO 3309) of the given data.

Source

pub fn estimate_encoded_size(&self, payload_size: usize) -> usize

Estimate the total encoded size for a payload of the given length.

Returns 4 + payload_size + (4 if checksum enabled).

Source

pub fn decode_length(&self, data: &[u8]) -> Result<usize, CodecError>

Peek at the length prefix without performing a full decode.

Returns the payload length encoded in the first 4 bytes.

§Errors
Source

pub fn stats(&self) -> CodecStats

Return cumulative codec statistics.

Source

pub fn config(&self) -> &CodecConfig

Return a reference to the current configuration.

Trait Implementations§

Source§

impl Debug for PeerMessageCodec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more