# Rust Input Function Example (`lukaskrivka/rust-input-function-example`) Actor

Dynamically compile and run input-provided page function. Like Cheerio Scraper but in Rust.

- **URL**: https://apify.com/lukaskrivka/rust-input-function-example.md
- **Developed by:** [Lukáš Křivka](https://apify.com/lukaskrivka) (community)
- **Categories:** Developer tools, Open source
- **Stats:** 5 total users, 0 monthly users, 0.0% runs succeeded, 2 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

Example actor showcasing running a user-provided function in a static-typed compiled language.

### How does it work
1. Reads the input from disk or via Apify API
2. Extracts the `page_function` string from the input
3. Stores the `page_function` string to the disk
4. Spawns a system process using `cargo` to compile the `page_function` into a dynamic library 
5. Dynamically links the library and converts the `page_function` into a regular Rust function. It must adhere to predefined input/output types. 
6. The example code gets HTML from the input provided `url` and parses it into a `document` using the [Scraper](https://docs.rs/scraper/latest/scraper/) library 
7. The user-provided `page_function` gets the `document` as an input parameter and returns a JSON [Value](https://docs.rs/serde_json/latest/serde_json/enum.Value.html) type using the `json` macro

### Page function
Page function can use a predefined set of Rust libraries, currently only the [Scraper](https://docs.rs/scraper/latest/scraper/) library and [serde_json](https://docs.rs/serde_json/latest/serde_json/) for JSON `Value` type are provided. 

#### TODO
But technically, thanks to dynamic compiling, we can enable users to provide a list of libraries to be used in the `page_function`.

#### Example page_function
```rust
use serde_json::{Value,json};
use scraper::{Html, Selector};

fn selector_to_text(document: &Html, selector: &str) -> Option<String> {
    document
        .select(&Selector::parse(selector).unwrap())
        .next()
        .map(|el| el.text().next().unwrap().into() )
}

#[no_mangle]
pub fn page_function (document: &Html) -> Value { 
    println!("page_function starting");

    let title = selector_to_text(&document, "title");
    println!("extracted title: {:?}", title);

    let header = selector_to_text(&document, "h1");
    println!("extracted header: {:?}", header);

    let companies_using_apify = document
        .select(&Selector::parse(".Logos__container").unwrap())
        .next().unwrap()
        .select(&Selector::parse("img").unwrap())
        .map(|el| el.value().attr("alt").unwrap().to_string())
        .collect::<Vec<String>>();

    println!("extracted companies_using_apify: {:?}", companies_using_apify);

    let output = json!({
        "title": title,
        "header": header,
        "companies_using_apify": companies_using_apify,
    });
    println!("inside pageFunction output: {:?}", output);
    output
}
````

# Actor input Schema

## `url` (type: `string`):

hello

## `page_function` (type: `string`):

world

## `build_type` (type: `string`):

hello

## Actor input object example

```json
{
  "url": "https://apify.com",
  "page_function": "use serde_json::{Value,json};\nuse scraper::{Html, Selector};\n\nfn selector_to_text(document: &Html, selector: &str) -> Option<String> {\n    document\n        .select(&Selector::parse(selector).unwrap())\n        .next()\n        .map(|el| el.text().next().unwrap().into() )\n}\n\n#[no_mangle]\npub fn page_function (document: &Html) -> Value { \n    println!(\"page_function starting\");\n\n    let title = selector_to_text(&document, \"title\");\n    println!(\"extracted title: {:?}\", title);\n\n    let header = selector_to_text(&document, \"h1\");\n    println!(\"extracted header: {:?}\", header);\n\n    let companies_using_apify = document\n        .select(&Selector::parse(\".Logos__container\").unwrap())\n        .next().unwrap()\n        .select(&Selector::parse(\"img\").unwrap())\n        .map(|el| el.value().attr(\"alt\").unwrap().to_string())\n        .collect::<Vec<String>>();\n\n    println!(\"extracted companies_using_apify: {:?}\", companies_using_apify);\n\n    let output = json!({\n        \"title\": title,\n        \"header\": header,\n        \"companies_using_apify\": companies_using_apify,\n    });\n    println!(\"inside pageFunction output: {:?}\", output);\n    output\n}",
  "build_type": "debug"
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "url": "https://apify.com",
    "page_function": `use serde_json::{Value,json};
use scraper::{Html, Selector};

fn selector_to_text(document: &Html, selector: &str) -> Option<String> {
    document
        .select(&Selector::parse(selector).unwrap())
        .next()
        .map(|el| el.text().next().unwrap().into() )
}

#[no_mangle]
pub fn page_function (document: &Html) -> Value { 
    println!("page_function starting");

    let title = selector_to_text(&document, "title");
    println!("extracted title: {:?}", title);

    let header = selector_to_text(&document, "h1");
    println!("extracted header: {:?}", header);

    let companies_using_apify = document
        .select(&Selector::parse(".Logos__container").unwrap())
        .next().unwrap()
        .select(&Selector::parse("img").unwrap())
        .map(|el| el.value().attr("alt").unwrap().to_string())
        .collect::<Vec<String>>();

    println!("extracted companies_using_apify: {:?}", companies_using_apify);

    let output = json!({
        "title": title,
        "header": header,
        "companies_using_apify": companies_using_apify,
    });
    println!("inside pageFunction output: {:?}", output);
    output
}`
};

// Run the Actor and wait for it to finish
const run = await client.actor("lukaskrivka/rust-input-function-example").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "url": "https://apify.com",
    "page_function": """use serde_json::{Value,json};
use scraper::{Html, Selector};

fn selector_to_text(document: &Html, selector: &str) -> Option<String> {
    document
        .select(&Selector::parse(selector).unwrap())
        .next()
        .map(|el| el.text().next().unwrap().into() )
}

#[no_mangle]
pub fn page_function (document: &Html) -> Value { 
    println!(\"page_function starting\");

    let title = selector_to_text(&document, \"title\");
    println!(\"extracted title: {:?}\", title);

    let header = selector_to_text(&document, \"h1\");
    println!(\"extracted header: {:?}\", header);

    let companies_using_apify = document
        .select(&Selector::parse(\".Logos__container\").unwrap())
        .next().unwrap()
        .select(&Selector::parse(\"img\").unwrap())
        .map(|el| el.value().attr(\"alt\").unwrap().to_string())
        .collect::<Vec<String>>();

    println!(\"extracted companies_using_apify: {:?}\", companies_using_apify);

    let output = json!({
        \"title\": title,
        \"header\": header,
        \"companies_using_apify\": companies_using_apify,
    });
    println!(\"inside pageFunction output: {:?}\", output);
    output
}""",
}

# Run the Actor and wait for it to finish
run = client.actor("lukaskrivka/rust-input-function-example").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "url": "https://apify.com",
  "page_function": "use serde_json::{Value,json};\\nuse scraper::{Html, Selector};\\n\\nfn selector_to_text(document: &Html, selector: &str) -> Option<String> {\\n    document\\n        .select(&Selector::parse(selector).unwrap())\\n        .next()\\n        .map(|el| el.text().next().unwrap().into() )\\n}\\n\\n#[no_mangle]\\npub fn page_function (document: &Html) -> Value { \\n    println!(\\"page_function starting\\");\\n\\n    let title = selector_to_text(&document, \\"title\\");\\n    println!(\\"extracted title: {:?}\\", title);\\n\\n    let header = selector_to_text(&document, \\"h1\\");\\n    println!(\\"extracted header: {:?}\\", header);\\n\\n    let companies_using_apify = document\\n        .select(&Selector::parse(\\".Logos__container\\").unwrap())\\n        .next().unwrap()\\n        .select(&Selector::parse(\\"img\\").unwrap())\\n        .map(|el| el.value().attr(\\"alt\\").unwrap().to_string())\\n        .collect::<Vec<String>>();\\n\\n    println!(\\"extracted companies_using_apify: {:?}\\", companies_using_apify);\\n\\n    let output = json!({\\n        \\"title\\": title,\\n        \\"header\\": header,\\n        \\"companies_using_apify\\": companies_using_apify,\\n    });\\n    println!(\\"inside pageFunction output: {:?}\\", output);\\n    output\\n}"
}' |
apify call lukaskrivka/rust-input-function-example --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=lukaskrivka/rust-input-function-example",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Rust Input Function Example",
        "description": "Dynamically compile and run input-provided page function. Like Cheerio Scraper but in Rust.",
        "version": "0.0",
        "x-build-id": "vvqzTFH913umKi6zR"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/lukaskrivka~rust-input-function-example/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-lukaskrivka-rust-input-function-example",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/lukaskrivka~rust-input-function-example/runs": {
            "post": {
                "operationId": "runs-sync-lukaskrivka-rust-input-function-example",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/lukaskrivka~rust-input-function-example/run-sync": {
            "post": {
                "operationId": "run-sync-lukaskrivka-rust-input-function-example",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "url": {
                        "title": "URL",
                        "type": "string",
                        "description": "hello"
                    },
                    "page_function": {
                        "title": "Page Function",
                        "type": "string",
                        "description": "world"
                    },
                    "build_type": {
                        "title": "Compile page function",
                        "enum": [
                            "debug",
                            "release"
                        ],
                        "type": "string",
                        "description": "hello",
                        "default": "debug"
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
