Struct eosio_cdt::SingletonIndex

pub struct SingletonIndex<T: Table>(_);

TODO docs

Methods

impl<T: Table> SingletonIndex<T>

pub fn new<C, S>(code: C, scope: S) -> Self where
    C: Into<AccountName>,
    S: Into<ScopeName>, 

TODO docs

#[must_use] pub fn exists(&self) -> bool

Checks if the singleton entry exists

#[must_use] pub fn get(&self) -> Option<Result<T::Row, ReadError>>

Gets the value stored inside the singleton. Returns None if no value is found, or ReadError if there was an issue reading the data.

pub fn get_or_default(&self) -> Result<T::Row, ReadError> where
    T::Row: Default, 

Gets the value stored inside the singleton or returns the default value.

Errors

Will return Err if there was an issue deserializing the stored value.

pub fn set(&self, value: &T::Row, payer: AccountName) -> Result<(), WriteError>

Sets the singleton value

Errors

Will return Err if there was an issue serializing the value.

pub fn remove(&self) -> Result<Option<T::Row>, ReadError>

Removes the singleton value if it exists. Returns ReadError if there was an issue reading the data, and None if there was no entry found

Errors

Will return Err if there was an issue reading the stored value.