Struct PercentCodec 

pub struct PercentCodec;

Encodes and decodes percent-encoded UTF-8 text.

Its low-level Codec<Value = u8, Unit = u8> implementation converts one byte to either one unreserved ASCII unit or a %XX escape. UTF-8 validation remains part of the owned decode helper.

Examples

use qubit_codec_misc::PercentCodec;

let codec = PercentCodec::new();
let encoded = codec.encode("hello world");
assert_eq!(encoded, "hello%20world");
assert_eq!(codec.decode(&encoded).expect("valid encoded text"), "hello world");

Implementations

impl PercentCodec

pub fn new() -> Self

Creates a percent codec.

Returns

Percent codec.

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

Encodes text using percent encoding.

Parameters

• text: UTF-8 text to encode.

Returns

Percent-encoded text.

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

Decodes percent-encoded UTF-8 text.

Parameters

• text: Percent-encoded text.

Returns

Decoded UTF-8 text.

Errors

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

Trait Implementations

impl Clone for PercentCodec

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 PercentCodec

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

Returns the exact percent-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 percent 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 PercentCodec

impl Debug for PercentCodec

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

Formats the value using the given formatter.

impl Default for PercentCodec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PercentCodec

impl PartialEq for PercentCodec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PercentCodec

impl ValueDecoder<str> for PercentCodec

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

Decodes percent-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 PercentCodec

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

Encodes text using percent encoding.

type Error = MiscCodecError

Failure reported when one input value cannot be represented.

type Output = String

Owned representation produced from one input value.