renamer_rs/lib.rs
1#![warn(missing_docs)]
2//! # Rename-rs
3//! A library to process and rename files or text
4//!
5//! # Example
6//! ```rust
7//! # use renamer_rs::{Renamed, Delimiter, Selector, Format, Error, InputType};
8//!
9//! # fn run(delimiter: Delimiter, selector: Selector, format: Format, input: InputType) -> Result<Vec<Box<dyn Renamed>>, Error> {
10//! let processor = renamer_rs::ProcessorBuilder::new(format)
11//! .delimiter(delimiter)
12//! .selector(selector)
13//! .input(input);
14//! processor.process()
15//! }
16//!
17//! ```
18
19mod error;
20mod processor;
21
22pub use crate::error::Error;
23pub use crate::processor::ProcessorBuilder;
24pub use crate::processor::delimiter::{Delimiter, DelimiterType};
25pub use crate::processor::extractor::Extractor;
26pub use crate::processor::format::Format;
27pub use crate::processor::inputs::{FileInput, InputType, TextInput};
28pub use crate::processor::rename::Renamed;
29pub use crate::processor::replacer::Replacer;
30pub use crate::processor::selector::Selector;
31pub use crate::processor::trim::Trim;