Skip to main content

CustomEncoder

Struct CustomEncoder 

Source
pub struct CustomEncoder { /* private fields */ }
Expand description

A custom encoder that wraps a callable.

This is useful for creating encoders from closures or function pointers without defining a new type. Closures may capture state.

§Thread Safety

CustomEncoder is Send and Sync.

§Example

use attackstr::{CustomEncoder, Encoder};

let salt = "abc".to_string();
let encoder = CustomEncoder::new(move |s: &str| format!("{salt}{s}"));
assert_eq!(encoder.encode("hello"), "abchello");

Implementations§

Source§

impl CustomEncoder

Source

pub fn new<F>(func: F) -> Self
where F: Fn(&str) -> String + Send + Sync + 'static,

Create a new CustomEncoder from a closure or function pointer.

Example:

use attackstr::{CustomEncoder, Encoder};

let encoder = CustomEncoder::new(|value| value.to_uppercase());
assert_eq!(encoder.encode("xss"), "XSS");
Source

pub fn encode(&self, input: &str) -> String

Apply the encoding to an input string.

Example:

use attackstr::CustomEncoder;

let encoder = CustomEncoder::new(|value| format!("<{value}>"));
assert_eq!(encoder.encode("a"), "<a>");

Trait Implementations§

Source§

impl Clone for CustomEncoder

Source§

fn clone(&self) -> CustomEncoder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CustomEncoder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CustomEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for CustomEncoder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Encoder for CustomEncoder

Source§

fn encode(&self, input: &str) -> String

Encode the input string.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more