Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use impl Encoder in more places to simplify function usage #572

Merged
merged 1 commit into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

See [`UPGRADE.md`](./UPGRADE.md) for additional help when upgrading to newer versions.

## [unreleased]

### Changed

* Use `impl Encoder` on more functions (in particular on `send`) (#572)

## [0.30.0] - 2023-10-11

### Added
Expand Down
31 changes: 18 additions & 13 deletions rustler/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,7 @@ impl<'a> Env<'a> {
}

/// Convenience method for building a tuple `{error, Reason}`.
pub fn error_tuple<T>(self, reason: T) -> Term<'a>
where
T: Encoder,
{
pub fn error_tuple(self, reason: impl Encoder) -> Term<'a> {
let error = crate::types::atom::error().to_term(self);
(error, reason).encode(self)
}
Expand All @@ -83,7 +80,7 @@ impl<'a> Env<'a> {
/// Panics if the above rules are broken (by trying to send a message from
/// an `OwnedEnv` on a thread that's managed by the Erlang VM).
///
pub fn send(self, pid: &LocalPid, message: Term<'a>) -> Result<(), SendError> {
pub fn send(self, pid: &LocalPid, message: impl Encoder) -> Result<(), SendError> {
let thread_type = unsafe { rustler_sys::enif_thread_type() };
let env = if thread_type == rustler_sys::ERL_NIF_THR_UNDEFINED {
ptr::null_mut()
Expand All @@ -99,6 +96,8 @@ impl<'a> Env<'a> {
panic!("Env::send(): unrecognized calling thread type");
};

let message = message.encode(self);

// Send the message.
let res = unsafe {
rustler_sys::enif_send(env, pid.as_c_arg(), ptr::null_mut(), message.as_c_arg())
Expand All @@ -120,7 +119,8 @@ impl<'a> Env<'a> {
/// - `Some(pid)` if `name_or_pid` is an atom and an alive process is currently registered under the given name.
/// - `None` if `name_or_pid` is an atom but there is no alive process registered under this name.
/// - `None` if `name_or_pid` is not a PID or atom.
pub fn whereis_pid(&self, name_or_pid: Term<'a>) -> Option<LocalPid> {
pub fn whereis_pid(self, name_or_pid: impl Encoder) -> Option<LocalPid> {
let name_or_pid = name_or_pid.encode(self);
if name_or_pid.is_pid() {
return Some(name_or_pid.decode().unwrap());
}
Expand Down Expand Up @@ -198,9 +198,9 @@ impl OwnedEnv {
}

/// Run some code in this environment.
pub fn run<F, R>(&self, closure: F) -> R
pub fn run<'a, F, R>(&self, closure: F) -> R
where
F: for<'a> FnOnce(Env<'a>) -> R,
F: FnOnce(Env<'a>) -> R,
{
let env = unsafe { Env::new(&(), *self.env) };
closure(env)
Expand All @@ -219,15 +219,20 @@ impl OwnedEnv {
/// can only use this method on a thread that was created by other
/// means. (This curious restriction is imposed by the Erlang VM.)
///
pub fn send_and_clear<F>(&mut self, recipient: &LocalPid, closure: F) -> Result<(), SendError>
pub fn send_and_clear<'a, F, T>(
&mut self,
recipient: &LocalPid,
closure: F,
) -> Result<(), SendError>
where
F: for<'a> FnOnce(Env<'a>) -> Term<'a>,
F: FnOnce(Env<'a>) -> T,
T: Encoder,
{
if unsafe { rustler_sys::enif_thread_type() } != rustler_sys::ERL_NIF_THR_UNDEFINED {
panic!("send_and_clear: current thread is managed");
}

let message = self.run(|env| closure(env).as_c_arg());
let message = self.run(|env| closure(env).encode(env).as_c_arg());

let res = unsafe {
rustler_sys::enif_send(ptr::null_mut(), recipient.as_c_arg(), *self.env, message)
Expand Down Expand Up @@ -287,9 +292,9 @@ impl OwnedEnv {
///
/// **Note: There is no way to save terms across `OwnedEnv::send()` or `clear()`.**
/// If you try, the `.load()` call will panic.
pub fn save(&self, term: Term) -> SavedTerm {
pub fn save(&self, term: impl Encoder) -> SavedTerm {
SavedTerm {
term: self.run(|env| term.in_env(env).as_c_arg()),
term: self.run(|env| term.encode(env).as_c_arg()),
env_generation: Arc::downgrade(&self.env),
}
}
Expand Down
2 changes: 1 addition & 1 deletion rustler/src/term.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ impl<'a> Term<'a> {
self.term
}

pub fn get_env(&self) -> Env<'a> {
pub fn get_env(self) -> Env<'a> {
self.env
}

Expand Down
3 changes: 1 addition & 2 deletions rustler/src/thread.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
use crate::env::OwnedEnv;
use crate::types::atom::Atom;
use crate::{Encoder, Env, Term};
use crate::{Atom, Encoder, Env, Term};
use std::panic;
use std::thread;

Expand Down
3 changes: 2 additions & 1 deletion rustler/src/types/list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,9 @@ impl<'a> Term<'a> {
}

/// Adds `head` in a list cell with `self` as tail.
pub fn list_prepend(self, head: Term<'a>) -> Term<'a> {
pub fn list_prepend(self, head: impl Encoder) -> Term<'a> {
let env = self.get_env();
let head = head.encode(env);
unsafe {
let term = list::make_list_cell(env.as_c_arg(), head.as_c_arg(), self.as_c_arg());
Term::new(env, term)
Expand Down
Loading