-
Notifications
You must be signed in to change notification settings - Fork 273
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
Update examples in top-level readme. #588
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
use jsonrpc_core::{ | ||
futures::{self, FutureExt}, | ||
BoxFuture, IoHandler, Result, | ||
}; | ||
use jsonrpc_core_client::transports::local; | ||
use jsonrpc_derive::rpc; | ||
|
||
/// Rpc trait | ||
#[rpc] | ||
pub trait Rpc { | ||
/// Returns a protocol version | ||
#[rpc(name = "protocolVersion")] | ||
fn protocol_version(&self) -> Result<String>; | ||
|
||
/// Adds two numbers and returns a result | ||
#[rpc(name = "add", alias("callAsyncMetaAlias"))] | ||
fn add(&self, a: u64, b: u64) -> Result<u64>; | ||
|
||
/// Performs asynchronous operation | ||
#[rpc(name = "callAsync")] | ||
fn call(&self, a: u64) -> BoxFuture<Result<String>>; | ||
} | ||
|
||
struct RpcImpl; | ||
|
||
impl Rpc for RpcImpl { | ||
fn protocol_version(&self) -> Result<String> { | ||
Ok("version1".into()) | ||
} | ||
|
||
fn add(&self, a: u64, b: u64) -> Result<u64> { | ||
Ok(a + b) | ||
} | ||
|
||
fn call(&self, _: u64) -> BoxFuture<Result<String>> { | ||
Box::pin(futures::future::ready(Ok("OK".to_owned()))) | ||
} | ||
} | ||
|
||
fn main() { | ||
futures::executor::block_on(async { | ||
let mut io = IoHandler::new(); | ||
io.extend_with(RpcImpl.to_delegate()); | ||
println!("Starting local server"); | ||
let (client, server) = local::connect(io); | ||
let client = use_client(client).fuse(); | ||
let server = server.fuse(); | ||
|
||
futures::pin_mut!(client); | ||
futures::pin_mut!(server); | ||
|
||
futures::select! { | ||
server = server => {}, | ||
client = client => {}, | ||
} | ||
}); | ||
} | ||
|
||
async fn use_client(client: RpcClient) { | ||
let res = client.add(5, 6).await.unwrap(); | ||
println!("5 + 6 = {}", res); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"uncommented" because the example wouldn't terminate otherwise?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, is there some other way to prevent that? I guess we could mark it as "no-run"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we could either mark it
no_run
or hide the "uncommented" line from the docs by# // server.wait();
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no_run
feels inferior, since it won't detect the runtime errorsI can remove the comment completely, but I think it's easier if we make users aware they have to wait for the server. Can add an explanation comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes please. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.