Skip to main content

Encoder

Struct Encoder 

pub struct Encoder { /* private fields */ }
Available on crate features http-backend and http and quic and std only.
Expand description

Stateful encoder for one connection. Dynamic insertion and references, preferred or not, fall back to native representations when they cannot be honoured; invalid/oversized input fails before any state changes.

Implementations§

§

impl Encoder

pub fn new(config: EncoderConfig) -> Encoder

Create an encoder with the peer settings and local budgets.

pub fn before_peer_settings(config: EncoderConfig) -> Encoder

Create a connection encoder before receiving peer SETTINGS.

Only static and literal representations are used until Self::apply_peer_settings. The configured target capacity and local budgets are retained for negotiation.

pub fn apply_peer_settings( &mut self, settings: &Settings, ) -> Result<(), QpackError>

Apply the first peer SETTINGS without replacing decoder-stream parser state.

This is valid exactly once on an encoder created with Self::before_peer_settings. The connection driver must reject subsequent SETTINGS as H3_FRAME_UNEXPECTED.

pub fn known_received_count(&self) -> u64

Number of insertions acknowledged by the peer.

pub fn insert_count(&self) -> u64

Number of dynamic entries inserted over the connection lifetime.

pub fn tracked_section_count(&self) -> usize

Number of sections awaiting acknowledgment.

pub fn tracked_reference_count(&self) -> usize

Number of outstanding references retained for acknowledgment/cancellation.

pub fn encoder_stream_len(&self) -> usize

Number of queued encoder-stream bytes.

pub fn take_encoder_stream(&mut self) -> Bytes

Take queued encoder-stream bytes in order.

pub fn encode<'a, I, F, N, V>( &mut self, stream_id: u64, fields: I, ) -> Result<Bytes, QpackError>
where I: IntoIterator<Item = F>, F: Into<EncodeField<'a, N, V>>, N: AsRef<[u8]>, V: AsRef<[u8]>,

Encode ordered fields for a HEADERS/PUSH_PROMISE payload. Tuples represent ordinary fields; EncodeField or decoded FieldPair values preserve sensitivity.

Input size and stream ID are validated before any connection state changes. A tracking or encoder-output budget prevents dynamic compression rather than failing the section.

After stream cancellation, this stream and older IDs in the same QUIC stream class use static/literal representations. Later IDs can still use dynamic compression. This bounded bookkeeping leaves previously outstanding references on other streams intact.

pub fn encode_with_base<'a, I, F, N, V>( &mut self, stream_id: u64, fields: I, base_policy: FieldSectionBase, ) -> Result<Bytes, QpackError>
where I: IntoIterator<Item = F>, F: Into<EncodeField<'a, N, V>>, N: AsRef<[u8]>, V: AsRef<[u8]>,

Encode with a section-local Base policy.

FieldSectionBase::FromFieldPreferences plans positioned dynamic reference families and current-field insertions before changing connection state. A preference that cannot be honoured, under any policy, falls back to the native representation of that field; the section itself never fails for it.

pub fn on_decoder_instruction( &mut self, inst: DecoderInstruction, ) -> Result<(), QpackError>

Apply one decoded feedback instruction (RFC 9204 §4.4).

pub fn feed_decoder_stream(&mut self, input: &[u8]) -> Result<(), QpackError>

Process arbitrarily fragmented decoder-stream bytes, retaining at most eleven bytes of one incomplete instruction. Complete instructions before a malformed one remain applied.

pub fn is_at_decoder_instruction_boundary(&self) -> bool

Whether feedback ends on an instruction boundary. The connection driver handles critical stream closure; this reports a partial instruction for diagnostics and incremental tests.

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
§

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

§

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

§

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

§

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
§

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

§

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.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

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

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

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

§

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

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

§

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

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

fn try_from(value: U) -> Result<T, !>

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

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

§

fn vzip(self) -> V

§

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer
§

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer
§

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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