epage / p4-cmd

P4 Rust API (wraps CLI)

p4-cmd

Perforce API for Rust

Usage

To include p4-cmd in your project add the following to your Cargo.toml:

[dependencies]
p4-cmd = "0.1"

Now you can use the crate in your code:

extern crate p4_cmd;

Note: This requires the p4 binary to be available.

Why wrap the p4 binary rather than the API?

• The API is in C++ and would require first wrapping in C.
• The API would not be Sync, requiring more work to have a Sync API.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

p4-cmd's Issues

Support retries

Figure out how failed commands should behave

Currently, an OperationError is returned along with the user's data.

How should we handle this?

Address unwrap's

When running p4 and parsing, we currently unwrap, rather than return errors.

Support overriding the p4 command

This is useful if it is being used in a non-install scenario.

Make files, dirs, where `extend`

This will make it a lot easier to populate these commands withs rather than doing it one-at-atime

Implement sync command

Make Commands take in an iterable instead of a single path?

Right now, if you want to initialize one of these commands with an iterator. you have to iter.next() into new and then loop over the push function (or use extend, see #3).

It'd be simpler if the command just took in an iterable. But would that make the naive case too cumbersome?

Improve documentation for how a Command leads to an item

Right now if you look at a Command, run returns blob. That blob can then be iterated over for Item<T>. It takes a lot of just the right clicks to get to T.

We should make this clearer.

Avoid stringly typed file specs

Right now file specs are strings. We could make them a lot smarter.

See https://www.perforce.com/perforce/r15.1/manuals/cmdref/filespecs.html

Implement print command