Skip to main content

USAGE

Constant USAGE 

Source
pub const USAGE: &str = "Usage: crossmap encode     <crosswalk.json> <document.json>
       crossmap decode     <crosswalk.json> <document.json>
       crossmap validate   <crosswalk.json>
       crossmap round-trip <crosswalk.json> <samples.json>

Applies a crossmap crosswalk to JSON documents.

  encode      prints the document translated from the crosswalk's source shape
              to its target shape
  decode      prints the document translated back, from target shape to source
  validate    checks the crosswalk's schema and structure, printing nothing
              when it is sound
  round-trip  checks that decoding the encoding of every sample reproduces it
              on the paths the crosswalk preserves; <samples.json> is a JSON
              array of source-shape documents. Prints nothing on success

  <crosswalk.json>  the crosswalk: a path, a URL, or - to read it from standard
                    input
  <document.json>   the document: a path, a URL, or - to read it from standard
                    input
  -h, --help        show this text
  -v, --version     show the version

A URL is an http:, https:, data: or file: address; any other scheme is
unsupported. Only one argument may be -. Output is JSON on standard output.

Exit status: 0 on success, 1 when the library rejected the crosswalk or the
document (the reason is on standard error), 2 for bad usage or an argument that
cannot be read (a missing file, a failed fetch, an unsupported scheme) or is
not JSON.
";
Expand description

The usage text.