Struct struckdown::processors::External

pub struct External {
    pub cmd: PathBuf,
    pub args: Vec<String>,
    pub env: BTreeMap<String, String>,
    pub cwd: Option<PathBuf>,
}

Passes a JSON serialized stream through an external program.

When applied this wraps the stream in a ExternalIter.

Fields

cmd: PathBuf

The executable to run.

args: Vec<String>

The arguments to pass to the external command.

env: BTreeMap<String, String>

Optional environment variables to pass.

cwd: Option<PathBuf>

An optional working directory.

Trait Implementations

impl Clone for External

pub fn clone(&self) -> External

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for External

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for External

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Processor for External

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

impl Serialize for External

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.