aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe-symfony-process/src/pipes/pipes_interface.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/shirabe-symfony-process/src/pipes/pipes_interface.rs')
-rw-r--r--crates/shirabe-symfony-process/src/pipes/pipes_interface.rs28
1 files changed, 28 insertions, 0 deletions
diff --git a/crates/shirabe-symfony-process/src/pipes/pipes_interface.rs b/crates/shirabe-symfony-process/src/pipes/pipes_interface.rs
new file mode 100644
index 00000000..46609bb8
--- /dev/null
+++ b/crates/shirabe-symfony-process/src/pipes/pipes_interface.rs
@@ -0,0 +1,28 @@
+//! ref: composer/vendor/symfony/process/Pipes/PipesInterface.php
+
+use indexmap::IndexMap;
+use shirabe_php_shim::{Descriptor, PhpResource};
+
+pub const CHUNK_SIZE: i64 = 16384;
+
+/// PipesInterface manages descriptors and pipes for the use of proc_open.
+pub trait PipesInterface: std::fmt::Debug {
+ /// Returns an array of descriptors for the use of proc_open.
+ fn get_descriptors(&mut self) -> Vec<Descriptor>;
+
+ /// Returns an array of filenames indexed by their related stream in case these pipes use temporary files.
+ fn get_files(&self) -> IndexMap<i64, String>;
+
+ /// Reads data in file handles and pipes.
+ fn read_and_write(&mut self, blocking: bool, close: bool) -> IndexMap<i64, String>;
+
+ /// Returns if the current state has open file handles or pipes.
+ fn are_open(&self) -> bool;
+
+ /// Closes file handles and pipes.
+ fn close(&mut self);
+
+ /// Accessor for the `pipes` property populated by proc_open, keyed by fd index.
+ fn pipes(&self) -> &IndexMap<i64, PhpResource>;
+ fn pipes_mut(&mut self) -> &mut IndexMap<i64, PhpResource>;
+}