diff options
| -rw-r--r-- | src/recite/ps.rs | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/recite/ps.rs b/src/recite/ps.rs index 30c3d7c..431466e 100644 --- a/src/recite/ps.rs +++ b/src/recite/ps.rs @@ -1,4 +1,13 @@ #[macro_export] +/// Fork into a process from a [Verse] +/// +/// Figures out whether or not the given [Verse] is a couplet. If it is, fork +/// into a process, and pipe the contents of out `out` into STDIN. If not, then +/// simply fork into the process. +/// +/// # Arguments +/// * `$verse: &Verse` - The verse to fork into +/// * `$out: &mut String` - If the $verse is a couplet, the contents of STDOUT from the last verse macro_rules! task { ($verse:expr, $out:expr) => { if $verse.couplet { @@ -18,6 +27,16 @@ macro_rules! task { }; } +/// Fork into a process from a [Verse], and capture STDOUT +/// +/// Figures out whether or not the given [Verse] is a couplet. If it is, fork +/// into a process, and pipe the contents of out `out` into STDIN. If not, then +/// simply fork into the process. Additionally, this function will capture +/// STDOUT of the process specified by the [Verse], and store it in `out`. +/// +/// # Arguments +/// * `$verse: &Verse` - The verse to fork into +/// * `$out: &mut String` - If the $verse is a couplet, the contents of STDOUT from the last verse #[macro_export()] macro_rules! ctask { ($verse:expr, $out:expr) => { |