Struct sanitizer::StringSanitizer

pub struct StringSanitizer(_);

The Sanitizer structure is a wrapper over a String type which is to be sanitized.

Example

use sanitizer::prelude::*;

let mut instance = StringSanitizer::from(" HELLO ");
instance
	.trim()
	.to_lowercase();
assert_eq!(instance.get(), "hello");

Implementations

impl StringSanitizer

pub fn new(content: String) -> Self

Create a new instance of the struct with the content as the string specified in the argument

pub fn get(self) -> String

Consume the struct and return the underlying string

pub fn trim(&mut self) -> &mut Self

Trim the string

pub fn numeric(&mut self) -> &mut Self

Remove non numeric characters from the string

pub fn alphanumeric(&mut self) -> &mut Self

Remove non alphanumeric characters from the string

pub fn to_lowercase(&mut self) -> &mut Self

Convert string to lower case

pub fn to_uppercase(&mut self) -> &mut Self

Convert string to upper case

pub fn to_camel_case(&mut self) -> &mut Self

Convert string to camel case

pub fn to_snake_case(&mut self) -> &mut Self

Convert string to snake case

pub fn to_screaming_snakecase(&mut self) -> &mut Self

Convert string to screaming snake case

pub fn clamp_max(&mut self, limit: usize) -> &mut Self

Set the maximum lenght of the content

pub fn e164(&mut self) -> &mut Self

Convert the phone number to the E164 International Standard

pub fn cut(&mut self, amount: usize) -> &mut Self

Truncate the string with the given amount

pub fn call<F>(&mut self, func: F) -> &mut Self where
    F: FnOnce(&str) -> String, 

Call a custom function for sanitizing the string

Trait Implementations

impl From<&'_ str> for StringSanitizer

fn from(content: &str) -> Self

Performs the conversion.

impl From<String> for StringSanitizer

fn from(content: String) -> Self

Performs the conversion.