Struct FormUrlencodedCodec 

pub struct FormUrlencodedCodec;

Encodes and decodes application/x-www-form-urlencoded text fragments.

Its low-level Codec<Value = u8, Unit = u8> implementation converts one byte at a time, including the form-specific space and + mapping. UTF-8 validation remains part of the owned decode helper. Streaming skip/replace hooks may consume the malformed span visible in the current input chunk, so recovery output for malformed input can depend on chunk boundaries. This does not affect valid input or strict decoding.

Examples

use qubit_codec_misc::FormUrlencodedCodec;

let codec = FormUrlencodedCodec::new();
let encoded = codec.encode("hello world");
assert_eq!(encoded, "hello+world");
assert_eq!(codec.decode(&encoded).unwrap(), "hello world");

Implementations

impl FormUrlencodedCodec

pub fn new() -> Self

Creates a form-url-encoded codec.

Returns

Form URL encoded codec.

pub fn encode(&self, text: &str) -> String

Encodes text, using + for spaces.

Parameters

• text: Text to encode.

Returns

Form-url-encoded text.

pub fn decode(&self, text: &str) -> MiscCodecResult<String>

Decodes text, treating + as space.

Parameters

• text: Text to decode.

Returns

Decoded UTF-8 text.

Errors

Returns MiscCodecError when an escape is malformed or decoded bytes are not valid UTF-8.

Trait Implementations

impl Clone for FormUrlencodedCodec

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Codec for FormUrlencodedCodec

fn encode_len(&self, value: &u8) -> usize

Returns the exact form-url-encoded width for one byte.

unsafe fn decode( &mut self, input: &[u8], input_index: usize, ) -> Result<(u8, NonZeroUsize), DecodeFailure<Self::DecodeError>>

Decodes one raw byte, +, or %XX escape.

Safety

The caller must provide an input index with at least one readable unit and a slice satisfying the codec trait’s decode preconditions.

unsafe fn encode( &mut self, value: &u8, output: &mut [u8], output_index: usize, ) -> Result<usize, Self::EncodeError>

Encodes one byte using form URL encoding.

Safety

The caller must provide enough writable output units for Self::encode_len.

unsafe fn decode_eof( &mut self, input: &[u8], input_index: usize, ) -> Result<(u8, NonZeroUsize), DecodeFailure<Self::DecodeError>>

Decodes one value after end of input has been confirmed.

Safety

The caller must provide an input index with at least one readable unit and a slice satisfying the codec trait’s EOF decode preconditions.

const MIN_UNITS_PER_VALUE: usize = 1

The minimum possible non-zero readable unit count for one decoded value.

const MAX_ENCODE_UNITS_PER_VALUE: usize = 3

The maximum unit count emitted when encoding one value.

const MAX_DECODE_UNITS_PER_VALUE: usize = 3

The maximum non-zero unit count consumed to decode one value.

type Value = u8

The type of logical values decoded from or encoded into the buffer.

type Unit = u8

The type of buffer units used by the encoded representation.

type DecodeError = MiscCodecError

The type of errors reported when decoding malformed units.

type EncodeError = MiscCodecError

The type of errors reported when encoding an unsupported value.

const MAX_ENCODE_RESET_UNITS: usize = 0

The maximum unit count emitted when resetting encode state.

const MAX_ENCODE_FINISH_UNITS: usize = 0

The maximum unit count emitted when finishing encode state at EOF.

const MAX_DECODE_RESET_VALUES: usize = 0

The maximum value count emitted when resetting decode state.

const MAX_DECODE_FINISH_VALUES: usize = 0

The maximum value count emitted when finishing decode state.

fn can_encode_value(&self, _value: &Self::Value) -> bool

Returns whether value is in this codec’s encodable value domain.

unsafe fn encode_reset( &mut self, _output: &mut [Self::Unit], _output_index: usize, ) -> Result<usize, Self::EncodeError>

Emits stream-start output and resets encode-side state.

unsafe fn encode_finish( &mut self, _output: &mut [Self::Unit], _output_index: usize, ) -> Result<usize, Self::EncodeError>

Emits EOF trailer output and finishes encode-side state.

unsafe fn decode_reset( &mut self, _output: &mut [Self::Value], _output_index: usize, ) -> Result<usize, Self::DecodeError>

Emits stream-start values and resets decode-side state.

unsafe fn decode_finish( &mut self, _output: &mut [Self::Value], _output_index: usize, ) -> Result<usize, Self::DecodeError>

Finishes decode-side EOF state into output.

impl Copy for FormUrlencodedCodec

impl Debug for FormUrlencodedCodec

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

Formats the value using the given formatter.

impl Default for FormUrlencodedCodec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FormUrlencodedCodec

impl PartialEq for FormUrlencodedCodec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FormUrlencodedCodec

impl ValueDecoder<str> for FormUrlencodedCodec

fn decode(&mut self, input: &str) -> Result<Self::Output, Self::Error>

Decodes form-url-encoded text.

type Error = MiscCodecError

Error reported when Input cannot be decoded.

type Output = String

Owned value produced from one successfully decoded Input.

impl ValueEncoder<str> for FormUrlencodedCodec

fn encode(&mut self, input: &str) -> Result<Self::Output, Self::Error>

Encodes text, using + for spaces.

type Error = MiscCodecError

Failure reported when one input value cannot be represented.

type Output = String

Owned representation produced from one input value.