Struct streamson_lib::handler::file::File

pub struct File { /* fields omitted */ }

File handler responsible for storing data to a file.

Implementations

impl File

pub fn new(fs_path: &str) -> Result<Self, Handler>

Creates new File handler

Arguments

• fs_path - path to a file in the file system (will be truncated)

Returns

• Ok(File) - Handler was successfully created
• Err(_) - Failed to create handler

Errors

Error might occur when the file fails to open

pub fn set_use_path(self, use_path: bool) -> Self

Set whether to show path

Arguments

• use_path - should path be shown in the output

Example

use streamson_lib::handler;
let file = handler::File::new("output.txt")
    .unwrap()
    .set_use_path(true);

pub fn set_separator<S>(self, separator: S) -> Self where
    S: ToString, 

Set which separator will be used in the output

Note that every separator will be extended to every found item.

Arguments

• separator - how found record will be separated

Example

use streamson_lib::handler;
let file = handler::File::new("output.txt")
    .unwrap()
    .set_separator("######\n");

Trait Implementations

impl Handler for File

pub fn use_path(&self) -> bool

Should path be used

pub fn separator(&self) -> &str

A str which will be used to separate records

pub fn handle(
    &mut self,
    path: &Path,
    _matcher_idx: usize,
    data: Option<&[u8]>
) -> Result<Option<Vec<u8>>, Handler>

Calls handler on matched data

pub fn handle_idx(
    &mut self,
    _path: &Path,
    _matcher_idx: usize,
    _idx: Output
) -> Result<(), Handler>

Calls when an index occured

pub fn buffering_required(&self) -> bool

If true is returned a buffer will be used to store input data when matcher matches