multiversx_sc/storage/
storage_set.rs

1use unwrap_infallible::UnwrapInfallible;
2
3use crate::{
4    api::{
5        ErrorApi, ManagedBufferApiImpl, ManagedTypeApi, ManagedTypeApiImpl, StorageReadApi,
6        StorageReadApiImpl, StorageWriteApi, StorageWriteApiImpl, const_handles, use_raw_handle,
7    },
8    codec::*,
9    contract_base::ExitCodecErrorHandler,
10    err_msg,
11    types::{BigInt, BigUint, ManagedBuffer, ManagedBufferBuilder, ManagedRef, ManagedType},
12};
13
14use super::StorageKey;
15
16struct StorageSetOutput<'k, A>
17where
18    A: StorageWriteApi + ManagedTypeApi + ErrorApi + 'static,
19{
20    key: ManagedRef<'k, A, StorageKey<A>>,
21}
22
23impl<'k, A> StorageSetOutput<'k, A>
24where
25    A: StorageWriteApi + ManagedTypeApi + ErrorApi + 'static,
26{
27    #[inline]
28    fn new(key: ManagedRef<'k, A, StorageKey<A>>) -> Self {
29        StorageSetOutput { key }
30    }
31
32    fn set_managed_buffer(&self, managed_buffer: &ManagedBuffer<A>) {
33        A::storage_write_api_impl().storage_store_managed_buffer_raw(
34            self.key.buffer.get_handle(),
35            managed_buffer.handle.clone(),
36        );
37    }
38}
39
40impl<A> TopEncodeOutput for StorageSetOutput<'_, A>
41where
42    A: StorageWriteApi + ManagedTypeApi + ErrorApi + 'static,
43{
44    type NestedBuffer = ManagedBufferBuilder<A>;
45
46    fn set_slice_u8(self, bytes: &[u8]) {
47        self.set_managed_buffer(&bytes.into())
48    }
49
50    fn set_u64(self, value: u64) {
51        let handle: A::ManagedBufferHandle = use_raw_handle(const_handles::MBUF_TEMPORARY_1);
52        A::managed_type_impl().mb_from_small_int_unsigned(handle.clone(), value as i64);
53        let managed_buffer = unsafe { ManagedBuffer::from_handle(handle) };
54        self.set_managed_buffer(&managed_buffer);
55    }
56
57    /// The version that uses the buggy VM hook. Activate this flag to test the VM.
58    #[cfg(feature = "small-int-bug")]
59    fn set_i64(self, value: i64) {
60        let handle: A::ManagedBufferHandle = use_raw_handle(const_handles::MBUF_TEMPORARY_1);
61        A::managed_type_impl().mb_from_small_int_signed(handle.clone(), value);
62        let managed_buffer = unsafe { ManagedBuffer::from_handle(handle) };
63        self.set_managed_buffer(&managed_buffer);
64    }
65
66    /// Workaround for `mb_from_small_int_signed` bug: converts via BigInt first.
67    #[cfg(not(feature = "small-int-bug"))]
68    fn set_i64(self, value: i64) {
69        use crate::api::BigIntApiImpl;
70        let api = A::managed_type_impl();
71        let bi_handle: A::BigIntHandle = use_raw_handle(const_handles::BIG_INT_TEMPORARY_1);
72        api.bi_set_int64(bi_handle.clone(), value);
73        let mb_handle: A::ManagedBufferHandle = use_raw_handle(const_handles::MBUF_TEMPORARY_1);
74        api.mb_from_big_int_signed(bi_handle, mb_handle.clone());
75        let managed_buffer = unsafe { ManagedBuffer::from_handle(mb_handle) };
76        self.set_managed_buffer(&managed_buffer);
77    }
78
79    #[inline]
80    fn supports_specialized_type<T: TryStaticCast>() -> bool {
81        T::type_eq::<ManagedBuffer<A>>() || T::type_eq::<BigUint<A>>() || T::type_eq::<BigInt<A>>()
82    }
83
84    #[inline]
85    fn set_specialized<T, H>(self, value: &T, h: H) -> Result<(), H::HandledErr>
86    where
87        T: TryStaticCast,
88        H: EncodeErrorHandler,
89    {
90        if let Some(managed_buffer) = value.try_cast_ref::<ManagedBuffer<A>>() {
91            self.set_managed_buffer(managed_buffer);
92            Ok(())
93        } else if let Some(big_uint) = value.try_cast_ref::<BigUint<A>>() {
94            self.set_managed_buffer(&big_uint.to_bytes_be_buffer());
95            Ok(())
96        } else if let Some(big_int) = value.try_cast_ref::<BigInt<A>>() {
97            self.set_managed_buffer(&big_int.to_signed_bytes_be_buffer());
98            Ok(())
99        } else {
100            Err(h.handle_error(EncodeError::UNSUPPORTED_OPERATION))
101        }
102    }
103
104    fn start_nested_encode(&self) -> Self::NestedBuffer {
105        ManagedBufferBuilder::new_from_slice(&[])
106    }
107
108    fn finalize_nested_encode(self, nb: Self::NestedBuffer) {
109        self.set_managed_buffer(&nb.into_managed_buffer());
110    }
111}
112
113// #[inline]
114pub fn storage_set<A, T>(key: ManagedRef<'_, A, StorageKey<A>>, value: &T)
115where
116    T: TopEncode,
117    A: StorageWriteApi + ManagedTypeApi + ErrorApi,
118{
119    value
120        .top_encode_or_handle_err(
121            StorageSetOutput::new(key),
122            ExitCodecErrorHandler::<A>::from(err_msg::STORAGE_ENCODE_ERROR),
123        )
124        .unwrap_infallible()
125}
126
127/// Useful for storage mappers.
128/// Also calls to it generated by macro.
129pub fn storage_clear<A>(key: ManagedRef<'_, A, StorageKey<A>>)
130where
131    A: StorageWriteApi + ManagedTypeApi + ErrorApi,
132{
133    let value_handle: A::ManagedBufferHandle = use_raw_handle(const_handles::MBUF_CONST_EMPTY);
134    A::managed_type_impl().mb_overwrite(value_handle.clone(), &[]);
135
136    A::storage_write_api_impl().storage_store_managed_buffer_raw(key.get_handle(), value_handle);
137}
138
139/// Useful for storage mappers.
140/// Replaces the content from a key to another without decoding.
141pub fn storage_overwrite<A>(
142    from_key: ManagedRef<'_, A, StorageKey<A>>,
143    to_key: ManagedRef<'_, A, StorageKey<A>>,
144) where
145    A: StorageWriteApi + StorageReadApi + ManagedTypeApi + ErrorApi,
146{
147    let from_buffer_handle: A::ManagedBufferHandle =
148        use_raw_handle(const_handles::MBUF_TEMPORARY_1);
149
150    A::storage_read_api_impl()
151        .storage_load_managed_buffer_raw(from_key.get_handle(), from_buffer_handle.clone());
152    A::storage_write_api_impl()
153        .storage_store_managed_buffer_raw(to_key.get_handle(), from_buffer_handle);
154}
multiversx_sc/storage/storage_set.rs

multiversx_sc/storage/
storage_set.rs
