Struct zephyr_sdk::EnvClient

pub struct EnvClient { /* private fields */ }

Zephyr’s host environment client.

Implementations

impl EnvClient

pub fn read_contract_instance( &self, contract: [u8; 32] ) -> Result<Option<ContractDataEntry>, SdkError>

Returns the instance object of a certain contract from the host’s ledger.

pub fn read_contract_entry_by_key( &self, contract: [u8; 32], key: ScVal ) -> Result<Option<ContractDataEntry>, SdkError>

Returns the requested entry object of a certain contract from the host’s ledger.

pub fn read_contract_entries( &self, contract: [u8; 32] ) -> Result<Vec<ContractDataEntry>, SdkError>

Returns all the entry objects of a certain contract from the host’s ledger.

pub fn read_contract_entries_to_env( &self, env: &Env, contract: [u8; 32] ) -> Result<Map<Val, Val>, SdkError>

Returns all the entry objects of a certain contract from the host’s ledger. This function retuns an iteraror over Soroban host objects, and should be used along with the Soroban SDK.

impl EnvClient

pub fn log(&self) -> EnvLogger

Returns the logger object.

pub fn soroban(&self) -> &Env

Returns a soroban host stub.

pub fn from_scval<T: TryFromVal<Env, Val>>(&self, scval: &ScVal) -> T

Converts an ScVal into a soroban host object. Returns a Soroban Val. Panics when the conversion fails.

pub fn scval_to_valid_host_val<T: TryFromVal<Env, Val>>( &self, scval: &ScVal ) -> Result<T, SdkError>

Converts an ScVal into a soroban host object. Returns a result with a Soroban Val.

pub fn send_web_request(&self, request: AgnosticRequest)

Sends a web request message requests to the host.

pub fn read<T: DatabaseInteract>(&self) -> Vec<T>

Reads a database table.

This function uses the DatabaseInteract trait along with the DatabaseDerive macro to read the rows into a DatabaseDerive struct.

pub fn put<T: DatabaseInteract>(&self, row: &T)

Writes a row to a database table.

This function uses the DatabaseInteract trait along with the DatabaseDerive macro to write the row derived from the DatabaseDerive struct.

pub fn update(&self) -> UpdateTable

Updates a row to a database table.

This function uses the DatabaseInteract trait along with the DatabaseDerive macro to update the row derived from the DatabaseDerive struct.

pub fn update_inner<T: DatabaseInteract>( &self, row: &T, conditions: &[Condition] )

Updates a row to a database table.

This function uses the DatabaseInteract trait along with the DatabaseDerive macro to update the row derived from the DatabaseDerive struct.

pub fn db_write( &self, table_name: &str, columns: &[&str], segments: &[&[u8]] ) -> Result<(), SdkError>

Raw function to write to the database a row.

pub fn db_update( &self, table_name: &str, columns: &[&str], segments: &[&[u8]], conditions: &[Condition] ) -> Result<(), SdkError>

Raw function to update a database row.

pub fn db_read( &self, table_name: &str, columns: &[&str] ) -> Result<TableRows, SdkError>

Raw function to read from database.

pub fn reader(&self) -> MetaReader<'_>

Returns the XDR reader object.

pub fn new() -> Self

New instance of the zephyr client with the ledger meta already set.

pub fn empty() -> Self

New empty instance of the zephyr client.

pub fn conclude<T: Serialize>(&self, result: T)

Send a result to the host.

This function has no effect when used in ingestion zephyr programs and should only be used with serverless functions as target.

Trait Implementations

impl Clone for EnvClient

fn clone(&self) -> EnvClient

Returns a copy of the value.

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

Performs copy-assignment from source.