Struct DataApiScriptClient

pub struct DataApiScriptClient { /* private fields */ }

Data API script client.

The Data API script client should only be used if the OData API is not available or cannot be used for other reasons. Otherwise, you should use the crate::odata_api::ODataApiScriptClient.

When using the Data API client, you must specify a ScriptLayoutContext in order to execute script calls. See its documentation for further details.

Implementations

impl DataApiScriptClient

pub fn new(connection: Connection, context: ScriptLayoutContext) -> Self

Creates a new Data API script client.

Examples

use fm_script_client::Connection;
use fm_script_client::data_api::{DataApiScriptClient, ScriptLayoutContext};

let client = DataApiScriptClient::new(
    "https://foo:bar@example.com/example_database".try_into().unwrap(),
    ScriptLayoutContext::new("script_layout", "id", "1"),
);

pub async fn release_token(&self) -> Result<(), Error>

Releases the currently used token.

If the client has no token registered at the moment, it will return immediately. Otherwise, it will issue a DELETE against the FileMaker Data API and forget the token.

Trait Implementations

impl ScriptClient for DataApiScriptClient

fn execute<'life0, 'life1, 'async_trait, T, P>( &'life0 self, script_name: &'life1 str, parameter: Option<P>, ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where T: 'async_trait + DeserializeOwned, P: 'async_trait + Serialize + Send + Sync, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes a script with an optional parameter.

fn execute_without_parameter<'life0, 'life1, 'async_trait, T>( &'life0 self, script_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where T: 'async_trait + DeserializeOwned, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convenience method to execute a script without a parameter.