mmmrrr

mmmrrr

Rustler return and pass reference from Rust to Elixir and back to Rust

The starting point: The Erlang ODBC client has a “bug” where it only allows 4096 bytes to be returned per cell. The Rust odbc client has no such limitations.

The reasoning: I’d like to avoid Rust for the web layer, since that would result in a lot of training for my peers.

The (probably insane) idea: Use Rustler to provide a custom “odbc driver” that can be used from Elixir.

The problem: I’d need to store the established connections somewhere in Elixir in order to pass them to the query functions and I’m not quite sure if this would work with Rustlers unsafe functions.

So the questions are:

  1. How do I return a Rust reference to a “thing” to Elixir in order to pass it again to Rust later on?
  2. Is there anything that disqualifies this idea categorically (except from the fact that it is probably a huge effort)

First 10 of 45 Posts Switch mode

hauleth

hauleth

Use NIF resource for that, you probably will need to dig in Rustler docs how to do that in Rust.

tessi

tessi

@hauleth 's suggestion is on point.

If you need an example, you could look at wasmex (GitHub - tessi/wasmex: Execute WebAssembly from Elixir · GitHub).

For example, a WebAssembly module instance has an elixir representation with an attached Rust struct. It is passed down in some methods defined here to the Rust-layer.

In Rust-land, we override the Wasmex::Native module with the respective rust functions taking that rust-struct reference.

In instance.rs you can see how to attach structs (instance in my case) to elixir objects (new_from_bytes) and how to extract structs from elixir objects (e.g. function_export_exists).

dimitarvp

dimitarvp

Rustler 0.22.0-rc makes this a bit easier. It’s not very well documented but I’ve made it work mostly easily.

mmmrrr

mmmrrr OP

Could you give me a pointer (pun fully intended :smiley:), Dimitar?
I. e. what exactly is it that the new version will make easier?

dimitarvp

dimitarvp

Here’s something that should work with minimal changes:

use rustler::resource::ResourceArc;
use rustler::{Encoder, Env, Term};

rustler::atoms! { error, ok, }

type MyRustReturnType = YOUR_RUST_TYPE_HERE;

enum MyResult {
    Success(ResourceArc<MyRustReturnType>),
    Failure(String),
}

impl<'a> Encoder for MyResult {
    fn encode<'b>(&self, env: Env<'b>) -> Term<'b> {
        match self {
            MyResult::Success(arc) => (ok(), arc).encode(env),
            MyResult::Failure(msg) => (error(), msg).encode(env),
        }
    }
}

// or DirtyCpu, or just remove the "schedule" option and leave the clause to be simply: `#[rustler::nif]`
#[rustler::nif(schedule = "DirtyIo")]
fn something() -> MyResult {
  match function_that_can_fail() {
    Ok(rust_object) => MyResult::Success(ResourceArc::(rust_object)),
    Err(e) => MyResult::Failure(e.to_string()),
  }
}

You might need to remove the lifetime qualifiers though, can’t remember why my code needed them now. Using Rustler’s ResourceArc is crucial here; thanks to it you will receive the Rust object wrapped in a nice Erlang Reference which in the case of this function you’ll see in your iex console like so (in the case of success):

{:ok, #Reference<0.679634982.4171759622.38993>}

…or in case of failure:

{:error, "error message from Rust here"}

Then on the Elixir side you should take care to have the same something() function that Rustler will wrap and pass through to Rust (this is covered in Rustler’s guide). That’s basically it. Poke me if you need more help, Rustler could be tricky and it seems the maintainers don’t have time for it for a long time now.

mmmrrr

mmmrrr OP

Sweet! Thank you so much :slight_smile: (all of you that is ^_^)
I’ll try that once I get to that project again next week. This looks really promising.

BobbyMcWho

BobbyMcWho

I am also interested in doing this, I’m experimenting with something and will need to pass a reference to a rust object(? My rust knowledge is poor) to elixir so that I can later call other rust methods to it

mmmrrr

mmmrrr OP

@dimitarvp I tried to implement the solution you suggested with rustler 0.22.0-rc.0.
I now have the problem that the YOUR_RUST_TYPE_HERE type that I used instead does not implement the ResourceTypeProvider trait and I’m unsure how to impl that correctly… did you have to provide the trait implementation for the type you used in your application?

dimitarvp

dimitarvp

Doesn’t ring a bell from memory. Do you have a GitHub repo for me to look at?

EDIT: Actually this might be because you have incorrectly implemented Encoder – but not 100% sure.

mmmrrr

mmmrrr OP

Unfortunately no because the whole construct is a little complex by now…

But here is the actual code in the rust lib:

use rustler::resource::ResourceArc;
use rustler::{Encoder, Env, Term};

rustler::atoms! { error, ok, }

type DbConnection = odbx::Connection<odbx::AutocommitOn>;

enum DbConnectionResult {
    Success(ResourceArc<DbConnection>),
    Failure(String),
}

// impl ResourceTypeProvider for DbConnectionResult {
//     fn get_type() -> &'static ResourceType<Self> {
//         rustler::resource::ResourceType {}
//     }
// }

impl<'a> Encoder for DbConnectionResult {
    fn encode<'b>(&self, env: Env<'b>) -> Term<'b> {
        match self {
            DbConnectionResult::Success(arc) => (ok(), arc).encode(env),
            DbConnectionResult::Failure(msg) => (error(), msg).encode(env),
        }
    }
}

#[rustler::nif]
pub fn connect() -> DbConnectionResult {
    // Connect to database using connection string
    let connection_string = "DSN=SYA";
    match odbx::Odbc::connect(&connection_string) {
        Ok(conn) => DbConnectionResult::Success(ResourceArc::new(conn)),
        Err(e) => DbConnectionResult::Failure(String::from("Some error")),
    }
}

#[rustler::nif]
fn add(a: i64, b: i64) -> i64 {
    a + b
}

rustler::init!("Elixir.ExOdbc", [add, connect]);

odbx:: is a package I wrote to patch and adjust several rust odbc packages (which is what makes this whole thing a little complicated…)

The compiler is complaining about the Success(ResourceArc<DbConnection>), since Connection<AutocommitOn> does not implement the trait ResourceTypeProvider

Where Next?

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement