Skip to main content

ValueStringCodecDescriptor

Struct ValueStringCodecDescriptor 

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

An immutable, safely erased bidirectional string codec for one value type.

Each operation creates a fresh default codec; no codec state is retained between calls. Type identities are process-local and names are diagnostic, not stable IDs.

§Examples

use core::convert::Infallible;

use qubit_codec::ValueDecoder;
use qubit_codec::ValueEncoder;
use qubit_codec::ValueStringCodecDescriptor;

#[derive(Default)]
struct Text;
impl ValueEncoder<u32> for Text {
    type Output = String;
    type Error = Infallible;

    fn encode(&mut self, input: &u32) -> Result<String, Infallible> {
        Ok(input.to_string())
    }
}
impl ValueDecoder<str> for Text {
    type Output = u32;
    type Error = Infallible;

    fn decode(&mut self, input: &str) -> Result<u32, Infallible> {
        Ok(input.len() as u32)
    }
}

let descriptor = ValueStringCodecDescriptor::of::<Text, u32>();

// `encode` takes an erased `&dyn Any`, so the value type must be named.
let value: u32 = 7;
assert_eq!(descriptor.encode(&value).unwrap(), "7");

let decoded = descriptor.decode("hello").unwrap();
assert_eq!(*decoded.downcast::<u32>().unwrap(), 5);

Implementations§

Source§

impl ValueStringCodecDescriptor

Source

pub const fn of<C, V>() -> Self
where C: Default + ValueEncoder<V, Output = String> + ValueDecoder<str, Output = V> + 'static, <C as ValueEncoder<V>>::Error: Error + 'static, <C as ValueDecoder<str>>::Error: Error + 'static, V: 'static,

Creates a descriptor for codec C and value type V.

§Type Parameters
  • C: Default-constructible string encoder/decoder with owned errors.
  • V: Owned value type accepted and produced by C.
§Returns

Returns immutable function metadata without constructing a codec.

Source

pub fn codec_type_id(&self) -> TypeId

Returns the process-local identity of the concrete codec.

§Returns

Returns the TypeId of the codec this descriptor was built for.

Source

pub fn codec_type_name(&self) -> &'static str

Returns the diagnostic name of the concrete codec.

§Returns

Returns the type_name of the codec, for diagnostics only.

Source

pub fn value_type_id(&self) -> TypeId

Returns the process-local identity of the decoded value.

§Returns

Returns the TypeId of the value this descriptor accepts and produces.

Source

pub fn value_type_name(&self) -> &'static str

Returns the diagnostic name of the decoded value.

§Returns

Returns the type_name of the value, for diagnostics only.

Source

pub fn encode( &self, value: &dyn Any, ) -> Result<String, ValueCodecExecutionError>

Encodes one erased value after checking its concrete type.

§Parameters
  • value: Borrowed value whose concrete type must match the descriptor.
§Returns

Returns an owned JSON string produced by a fresh default codec.

§Errors

Returns a type mismatch or the typed encoder source error.

Source

pub fn decode( &self, input: &str, ) -> Result<Box<dyn Any>, ValueCodecExecutionError>

Decodes one string into a safely erased value of the declared type.

§Parameters
  • input: String borrowed for one decoding operation.
§Returns

Returns a boxed owned value that can be downcast to the declared type.

§Errors

Returns the typed decoder source error.

Trait Implementations§

Source§

impl Clone for ValueStringCodecDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ValueStringCodecDescriptor

Source§

impl Debug for ValueStringCodecDescriptor

Source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats descriptor metadata without invoking either codec function.

§Parameters
  • formatter: Destination receiving the diagnostic type names.
§Returns

Returns success after both names have been formatted.

§Errors

Returns the underlying formatting failure.

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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.