Skip to main content

Codec

Struct Codec 

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

gRPC length-prefixed framing codec.

Handles the 5-byte gRPC frame header (1 byte compression flag + 4 byte big-endian length) and protobuf encode/decode with optional compression.

Implementations§

Source§

impl Codec

Source

pub fn new() -> Codec

Source

pub fn from_headers(headers: &HeaderMap) -> Codec

Source

pub fn set_limit(&mut self, limit: usize)

Set the maximum allowed size in bytes for a single gRPC message frame. Set to 0 for unlimited.

Source

pub const fn limit(&self) -> usize

Source

pub fn decode<T>(&self, src: &mut BytesMut) -> Result<Option<T>, ProtocolError>
where T: Message + Default,

Try to decode a complete gRPC message from src.

Consumes the frame bytes from src on success.

Returns:

  • Ok(Some(message)) when a complete frame is available
  • Ok(None) when more data is needed
  • Err on protocol violations (size limit, decode error)
Source

pub fn encode<T>( &self, msg: &T, dst: &mut BytesMut, ) -> Result<(), ProtocolError>
where T: Message,

Encode a protobuf message into gRPC length-prefixed framing.

Writes to dst: 1 byte compression flag + 4 byte big-endian length + payload. When compression is enabled and the compress feature is active, the payload is compressed and the flag byte is set to 1.

Auto Trait Implementations§

§

impl Freeze for Codec

§

impl RefUnwindSafe for Codec

§

impl Send for Codec

§

impl Sync for Codec

§

impl Unpin for Codec

§

impl UnsafeUnpin for Codec

§

impl UnwindSafe for Codec

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<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<T> BorrowState<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

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