Trait ValueConvertible

Source

pub trait ValueConvertible: Serialize + DeserializeOwned {
    // Provided methods
    fn to_object(&self) -> Result<Value, ProtocolError>
       where Self: Sized { ... }
    fn into_object(self) -> Result<Value, ProtocolError>
       where Self: Sized { ... }
    fn from_object(value: Value) -> Result<Self, ProtocolError>
       where Self: Sized { ... }
    fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>
       where Self: Sized { ... }
}

Expand description

Convert to/from platform_value::Value using non-human-readable serde (Identifier = Value::Identifier(bytes), binary = Value::Bytes(bytes), raw byte fields preserved without stringification).

§⚠️ HR / non-HR divergence (Critical-1)

ValueConvertible calls platform_value::to_value, which uses a serializer that reports is_human_readable() == false. The mirror trait JsonConvertible uses serde_json::to_value, which reports true. Types whose Serialize impl branches on is_human_readable() produce structurally different output between the two paths:

Type	`to_json()` (HR)	`to_object()` (non-HR)
`platform_value::Identifier`	`"5bV6jUfh..."` (bs58 string)	`Value::Identifier([u8; 32])`
[`platform_value::BinaryData`]	`"sg=="` (base64 string)	`Value::Bytes(Vec<u8>)`
`Bytes20` / `Bytes32` / `Bytes36`	base64 string	`Value::Bytes32([u8; N])` etc.
`CoreScript`	`"dqkU..."` (base64 string)	`Value::Bytes(Vec<u8>)`

Do not assume self.to_object()?.try_into_json() ≡ self.to_json(). They render the same field as a string in one and a byte array in the other. Round-trip tests should exercise each path independently.

§⚠️ `ContentDeserializer` caveat

Manual Deserialize impls that branch on deserializer.is_human_readable() must also handle serde::__private::de::ContentDeserializer, used internally by #[serde(tag = "...")] enums. ContentDeserializer always reports is_human_readable: true regardless of the original source, so a non-HR platform_value::Value flowing into a tagged enum gets shape- inferred as if it were HR. Recipe: write a dual-shape visitor accepting both shapes in the HR branch via deserialize_any. See [platform_value::Bytes32::deserialize] for the canonical example, and rs-dpp/src/serialization/serde_bytes.rs for [u8; N] / Vec<u8>.

Provided Methods§

Source

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>
where Self: Sized,

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

ValueConvertible

Trait ValueConvertible Copy item path

§⚠️ HR / non-HR divergence (Critical-1)

§⚠️ ContentDeserializer caveat

Provided Methods§

fn to_object(&self) -> Result<Value, ProtocolError>where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>where Self: Sized,

Dyn Compatibility§

Implementors§

impl ValueConvertible for AddressWitness

impl ValueConvertible for PlatformAddress

impl ValueConvertible for AddressFundsFeeStrategyStep

impl ValueConvertible for StoredAssetLockInfo

impl ValueConvertible for AssetLockValue

impl ValueConvertible for ExtendedBlockInfo

impl ValueConvertible for ExtendedEpochInfo

impl ValueConvertible for FinalizedEpochInfo

impl ValueConvertible for Validator

impl ValueConvertible for ValidatorSet

impl ValueConvertible for TokenConfiguration

impl ValueConvertible for TokenConfigurationPresetFeatures

impl ValueConvertible for TokenConfigurationConvention

impl ValueConvertible for TokenConfigurationChangeItem

impl ValueConvertible for TokenConfigurationLocalization

impl ValueConvertible for TokenDistributionInfo

impl ValueConvertible for TokenDistributionType

impl ValueConvertible for TokenDistributionTypeWithResolvedRecipient

impl ValueConvertible for TokenDistributionRules

impl ValueConvertible for TokenKeepsHistoryRules

impl ValueConvertible for TokenMarketplaceRules

impl ValueConvertible for TokenTradeMode

impl ValueConvertible for DistributionFunction

impl ValueConvertible for TokenDistributionRecipient

impl ValueConvertible for TokenDistributionResolvedRecipient

impl ValueConvertible for TokenPerpetualDistribution

impl ValueConvertible for RewardDistributionMoment

impl ValueConvertible for RewardDistributionType

impl ValueConvertible for TokenPreProgrammedDistribution

impl ValueConvertible for AuthorizedActionTakers

impl ValueConvertible for ChangeControlRules

impl ValueConvertible for DataContractConfig

impl ValueConvertible for ArrayItemType

impl ValueConvertible for ContestedIndexFieldMatch

impl ValueConvertible for ContestedIndexResolution

impl ValueConvertible for IndexCountability

impl ValueConvertible for OrderBy

impl ValueConvertible for Group

impl ValueConvertible for DataContractInSerializationFormat

impl ValueConvertible for StorageKeyRequirements

impl ValueConvertible for Document

impl ValueConvertible for GroupActionEvent

impl ValueConvertible for GroupAction

impl ValueConvertible for GroupActionStatus

impl ValueConvertible for Identity

impl ValueConvertible for ContractBounds

impl ValueConvertible for IdentityPublicKey

impl ValueConvertible for AssetLockProof

impl ValueConvertible for StateTransition

impl ValueConvertible for StateTransitionProofResult

impl ValueConvertible for AddressCreditWithdrawalTransition

impl ValueConvertible for AddressFundingFromAssetLockTransition

impl ValueConvertible for AddressFundsTransferTransition

impl ValueConvertible for BatchedTransition

impl ValueConvertible for DocumentPurchaseTransition

impl ValueConvertible for DocumentTransferTransition

impl ValueConvertible for DocumentTransition

impl ValueConvertible for DocumentUpdatePriceTransition

impl ValueConvertible for TokenTransition

impl ValueConvertible for DocumentBaseTransition

impl ValueConvertible for BatchTransition

impl ValueConvertible for DocumentCreateTransition

impl ValueConvertible for DocumentDeleteTransition

impl ValueConvertible for DocumentReplaceTransition

impl ValueConvertible for TokenBurnTransition

impl ValueConvertible for TokenClaimTransition

impl ValueConvertible for TokenConfigUpdateTransition

impl ValueConvertible for TokenDestroyFrozenFundsTransition

impl ValueConvertible for TokenDirectPurchaseTransition

Trait ValueConvertible

§⚠️ `ContentDeserializer` caveat

fn to_object(&self) -> Result<Value, ProtocolError>
where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>
where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>
where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>
where Self: Sized,