Struct binary_enclave::Enclave

#[repr(C)]pub struct Enclave<T, const SIZE: usize> { /* fields omitted */ }

Our enclave that will store the serialized value within our binary

The Enclave defines the type we are serializing into the binary and also must be given a size for making room in the binary. If the serialized type is larger than this, the write will fail.

The size given will increase the size of the binary linearly. Setting this to an extremely large size will give you an extremely large binary.

Implementations

impl<T, const SIZE: usize> Enclave<T, SIZE> where
    T: Default + Serialize + DeserializeOwned + EnclaveLocator, 

pub const fn new() -> Self

Gives us a new Enclave with the size specified.

pub fn decode(&self) -> Result<T>

Deserialize the embedded Enclave into an instance of our specified type.

pub fn decode_or_default(&self) -> T

Deserialize the embedded Enclave or give a default instance

pub fn write(&self, payload: &T) -> Result<usize>

Write a new payload into the binary. This takes place by copying the binary, writing our payload into it, and moving the new binary overtop the current. This is required due to restrictions on some OS of modifying a binary currently being executing.