This repository was archived by the owner on Sep 14, 2023. It is now read-only.
Allow generic decoding of usage into a type#31
Merged
BurntSushi merged 1 commit intodocopt:masterfrom Oct 17, 2014
Merged
Conversation
When writing a generic decode function over any types, one is tempted to write
something along the lines of:
extern crate serialize;
extern crate docopt;
use serialize::Decodable;
fn foo<'a, T>(usage: &str) -> T
where T: Decodable<docopt::Decoder<'a>, docopt::Error> {
let map = docopt::docopt(usage).unwrap_or_else(|e| e.exit());
map.decode().unwrap_or_else(|e| e.exit())
}
Currently there are two problems with this approach.
1. The `docopt::Decoder` structure is private, so it cannot be referenced in a
function signature.
2. The lifetime parameter on `Decoder` prevents usage of the local variable
`map`. The `decode` function requires `&'a self`, which requires callers of
this function to provide a lifetime variable `'a` which is the lifetime of
the stack frame of `foo` itself. Sadly this cannot currently be done (higher
ranked trait lifetimes maybe?).
To work around these two problems, I've made the `Decoder` structure public and
changed the `decode` method on `ValueMap` to consume the map, removing the
lifetime parameter on `Decoder`.
There may be some more generic wizardry to get around this problem, but this at
least seems to work for now!
BurntSushi
added a commit
that referenced
this pull request
Oct 17, 2014
Allow generic decoding of usage into a type
Member
|
Sounds good to me! Thank you!
I think you mean higher kinded trait lifetimes? I've been wanting this for other reasons, like supporting streaming iterators. Here's some more context on the problem. |
Contributor
Author
|
Ah yes, I believe that is what I mean! Perhaps rust-lang/rfcs#387 would help here (I'm not actually sure) |
Member
|
Yeah, that actually does look plausible. I eagerly await it because zero-cost safe streaming iterators are freaking cool. (I can't think of any other language that has them.) |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
When writing a generic decode function over any types, one is tempted to write
something along the lines of:
Currently there are two problems with this approach.
docopt::Decoderstructure is private, so it cannot be referenced in afunction signature.
Decoderprevents usage of the local variablemap. Thedecodefunction requires&'a self, which requires callers ofthis function to provide a lifetime variable
'awhich is the lifetime ofthe stack frame of
fooitself. Sadly this cannot currently be done (higherranked trait lifetimes maybe?).
To work around these two problems, I've made the
Decoderstructure public andchanged the
decodemethod onValueMapto consume the map, removing thelifetime parameter on
Decoder.There may be some more generic wizardry to get around this problem, but this at
least seems to work for now! Does this seem ok to you?