ProxyDef

Struct ProxyDef 

Source
pub struct ProxyDef {
    pub shape: &'static Shape,
    pub convert_in: ProxyConvertInFn,
    pub convert_out: ProxyConvertOutFn,
}
Expand description

Definition of a proxy type for custom serialization/deserialization.

A ProxyDef specifies how to convert between a target type and a proxy type. This can be used at both the container level (on a struct/enum) and the field level.

§Container-level proxy

When applied to a struct or enum with #[facet(proxy = ProxyType)]:

  • Serialization: target → proxy via convert_out
  • Deserialization: proxy → target via convert_in

§Field-level proxy

When applied to a field with #[facet(proxy = ProxyType)]:

  • The field is serialized/deserialized through the proxy type
  • Requires TryFrom<ProxyType> for FieldType and TryFrom<&FieldType> for ProxyType

§Example (generated by derive macro)

ProxyDef {
    shape: <ProxyType as Facet>::SHAPE,
    convert_in: Self::__facet_proxy_convert_in,
    convert_out: Self::__facet_proxy_convert_out,
}

Fields§

§shape: &'static Shape

The shape of the proxy type.

§convert_in: ProxyConvertInFn

Converts from proxy type to target type (deserialization).

Called when deserializing: first deserialize into proxy, then convert to target.

§convert_out: ProxyConvertOutFn

Converts from target type to proxy type (serialization).

Called when serializing: convert target to proxy, then serialize proxy.

Trait Implementations§

Source§

impl Clone for ProxyDef

Source§

fn clone(&self) -> ProxyDef

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProxyDef

Available on crate feature alloc only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for ProxyDef

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