solana_sdk/
account_utils.rs

1//! useful extras for Account state
2use {
3    crate::{
4        account::{Account, AccountSharedData},
5        instruction::InstructionError,
6    },
7    bincode::ErrorKind,
8    std::cell::Ref,
9};
10
11/// Convenience trait to covert bincode errors to instruction errors.
12pub trait StateMut<T> {
13    fn state(&self) -> Result<T, InstructionError>;
14    fn set_state(&mut self, state: &T) -> Result<(), InstructionError>;
15}
16pub trait State<T> {
17    fn state(&self) -> Result<T, InstructionError>;
18    fn set_state(&self, state: &T) -> Result<(), InstructionError>;
19}
20
21impl<T> StateMut<T> for Account
22where
23    T: serde::Serialize + serde::de::DeserializeOwned,
24{
25    fn state(&self) -> Result<T, InstructionError> {
26        self.deserialize_data()
27            .map_err(|_| InstructionError::InvalidAccountData)
28    }
29    fn set_state(&mut self, state: &T) -> Result<(), InstructionError> {
30        self.serialize_data(state).map_err(|err| match *err {
31            ErrorKind::SizeLimit => InstructionError::AccountDataTooSmall,
32            _ => InstructionError::GenericError,
33        })
34    }
35}
36
37impl<T> StateMut<T> for AccountSharedData
38where
39    T: serde::Serialize + serde::de::DeserializeOwned,
40{
41    fn state(&self) -> Result<T, InstructionError> {
42        self.deserialize_data()
43            .map_err(|_| InstructionError::InvalidAccountData)
44    }
45    fn set_state(&mut self, state: &T) -> Result<(), InstructionError> {
46        self.serialize_data(state).map_err(|err| match *err {
47            ErrorKind::SizeLimit => InstructionError::AccountDataTooSmall,
48            _ => InstructionError::GenericError,
49        })
50    }
51}
52
53impl<T> StateMut<T> for Ref<'_, AccountSharedData>
54where
55    T: serde::Serialize + serde::de::DeserializeOwned,
56{
57    fn state(&self) -> Result<T, InstructionError> {
58        self.deserialize_data()
59            .map_err(|_| InstructionError::InvalidAccountData)
60    }
61    fn set_state(&mut self, _state: &T) -> Result<(), InstructionError> {
62        panic!("illegal");
63    }
64}
65
66#[cfg(test)]
67mod tests {
68    use {
69        super::*,
70        crate::{account::AccountSharedData, pubkey::Pubkey},
71    };
72
73    #[test]
74    fn test_account_state() {
75        let state = 42u64;
76
77        assert!(AccountSharedData::default().set_state(&state).is_err());
78        let res = AccountSharedData::default().state() as Result<u64, InstructionError>;
79        assert!(res.is_err());
80
81        let mut account = AccountSharedData::new(0, std::mem::size_of::<u64>(), &Pubkey::default());
82
83        assert!(account.set_state(&state).is_ok());
84        let stored_state: u64 = account.state().unwrap();
85        assert_eq!(stored_state, state);
86    }
87}
solana_sdk/account_utils.rs

solana_sdk/
account_utils.rs
