Struct ConvertArgs 

#[non_exhaustive]
pub struct ConvertArgs {
    pub input_args: HugrInputArgs,
    pub output: Output,
    pub format: Option<String>,
    pub text: bool,
    pub binary: bool,
    pub compress: bool,
    pub compression_level: Option<u8>,
}

Convert between different HUGR envelope formats.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input_args: HugrInputArgs

Hugr input.

output: Output

Output file. Use ‘-’ for stdout.

format: Option<String>

Output format. One of: json, model, model-exts, s-expression, s-expression-exts

text: bool

Use default text-based envelope configuration. Cannot be combined with –format or –binary.

binary: bool

Use default binary envelope configuration. Cannot be combined with –format or –text.

compress: bool

Enable zstd compression for the output

compression_level: Option<u8>

Zstd compression level (1-22, where 1 is fastest and 22 is best compression) Uses the default level if not specified.

Implementations

impl ConvertArgs

pub fn run_convert_with_io<R: Read, W: Write>( &mut self, input_override: Option<R>, output_override: Option<W>, ) -> Result<()>

Convert a HUGR between different envelope formats with optional input/output overrides.

Arguments

• input_override - Optional reader to use instead of the CLI input argument.
• output_override - Optional writer to use instead of the CLI output argument.

pub fn run_convert(&mut self) -> Result<()>

Convert a HUGR between different envelope formats

Trait Implementations

impl Args for ConvertArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for ConvertArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ConvertArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for ConvertArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ConvertArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.