Skip to content

Latest commit

 

History

History
94 lines (57 loc) · 3.73 KB

README.md

File metadata and controls

94 lines (57 loc) · 3.73 KB

Trimothy

docs.rs changelog
crates.io ci deps.rs
license contributions welcome

Trimothy is a small library that expands on the limited String- and slice-trimming capabilities provided by the standard library.

If any of these methods happened to be introduced into stable Rust in the future, they will simply be removed from here.

This crate is #![no_std]-compatible.

TrimSliceMatches

This trait adds the arbitrary, match-based trimming methods to &[u8], Vec<u8>, and Box<[u8]>:

Method Description
trim_matches Trim arbitrary leading and trailing bytes via callback.
trim_start_matches Trim arbitrary leading bytes via callback.
trim_end_matches Trim arbitrary trailing bytes via callback.

TrimMut

This trait brings mutable trimming support to String, Vec<u8>, and Box<[u8]>.

Method Description
trim_mut Trim leading and trailing whitespace (mutably).
trim_start_mut Trim leading whitespace (mutably).
trim_end_mut Trim trailing whitespace (mutably).

TrimMatchesMut

This trait brings mutable match-based trimming String, Vec<u8>, and Box<[u8]>.

Method Description
trim_matches_mut Trim arbitrary leading and trailing bytes via callback (mutably).
trim_start_matches_mut Trim arbitrary leading bytes via callback (mutably).
trim_end_matches_mut Trim arbitrary trailing bytes via callback (mutably).

NormalizeWhitespace

This trait exposes an iterator over byte/string slice contents that trims the edges and compacts/converts all inner, contiguous spans of whitespace to a single horizontal space.

This trait is implemented for &[u8], &str, and Iterators with u8/char items.

Method Description
normalized_whitespace Return a whitespace-normalizing iterator.
normalized_control_and_whitespace Return a control- and whitespace-normalizing iterator.

Installation

The dependency can be added the normal way:

[dependencies]
trimothy = "0.3"

License

Copyright © 2024 Blobfolio, LLC <[email protected]>

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <[email protected]>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.