Struct StorageLayer 

#[non_exhaustive]
pub struct StorageLayer<U = StandardUploader> {
    pub uploader: Option<U>,
    pub config: StorageLayerConfig,
}

Available on non-target_os=zkvm only.

A layer responsible for storing programs and inputs.

This layer handles the preparation of program and input data for the proof request. It can upload large programs and inputs to external storage, or include smaller inputs directly in the request as inline data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

uploader: Option<U>

StorageUploader used to upload programs and inputs.

If not provided, the layer cannot upload files and provided inputs must be no larger than StorageLayerConfig::inline_input_max_bytes.

config: StorageLayerConfig

Configuration controlling storage behavior.

Implementations

impl<S> StorageLayer<S>

where S: StorageUploader,

pub async fn process_program(&self, program: &[u8]) -> Result<Url>

Uploads a program binary and returns its URL.

This method requires a configured storage uploader and will return an error if none is available.

pub async fn process_env(&self, env: &GuestEnv) -> Result<RequestInput>

Processes a guest environment into a RequestInput.

Small inputs (as determined by configuration) will be included inline in the request. Larger inputs will be uploaded to external storage, requiring a configured storage uploader.

impl<S> StorageLayer<S>

pub fn new(uploader: Option<S>, config: StorageLayerConfig) -> Self

Creates a new StorageLayer with the given provider and configuration.

The storage uploader is used to upload programs and inputs to external storage.

Trait Implementations

impl Adapt<StorageLayer<NotProvided>> for RequestParams

type Output = RequestParams

The output type after processing by the layer.

type Error = Error

Error type that may be returned during processing.

async fn process_with( self, layer: &StorageLayer<NotProvided>, ) -> Result<Self::Output, Self::Error>

Processes this value with the provided layer.

impl<S> Adapt<StorageLayer<S>> for RequestParams

where S: StorageUploader,

type Output = RequestParams

The output type after processing by the layer.

type Error = Error

Error type that may be returned during processing.

async fn process_with( self, layer: &StorageLayer<S>, ) -> Result<Self::Output, Self::Error>

Processes this value with the provided layer.

impl<U: Clone> Clone for StorageLayer<U>

fn clone(&self) -> StorageLayer<U>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Default for StorageLayer<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Clone> From<Option<S>> for StorageLayer<S>

fn from(uploader: Option<S>) -> Self

Creates a StorageLayer from the given StandardUploader, using default values for all other fields.

Provided value is an Option such that whether the storage uploader is available can be reolved at runtime (e.g. from environment variables).

impl From<StorageLayerConfig> for StorageLayer<NotProvided>

fn from(config: StorageLayerConfig) -> Self

Converts to this type from the input type.

impl<S> From<StorageLayerConfig> for StorageLayer<S>

where S: StorageUploader + Default,

fn from(config: StorageLayerConfig) -> Self

Converts to this type from the input type.

impl Layer<&GuestEnv> for StorageLayer<NotProvided>

type Output = Input

The output type produced by this layer.

type Error = Error

Error type that may be returned by this layer.

async fn process(&self, env: &GuestEnv) -> Result<Self::Output, Self::Error>

Processes the input and returns the transformed output.

impl<S> Layer<(&[u8], &GuestEnv)> for StorageLayer<S>

where S: StorageUploader,

type Output = (Url, Input)

The output type produced by this layer.

type Error = Error

Error type that may be returned by this layer.

async fn process( &self, __arg1: (&[u8], &GuestEnv), ) -> Result<Self::Output, Self::Error>

Processes the input and returns the transformed output.