Skip to main content

PayloadConfig

Struct PayloadConfig 

Source
pub struct PayloadConfig {
    pub max_per_category: usize,
    pub deduplicate: bool,
    pub marker_prefix: String,
    pub exclude_categories: Vec<String>,
    pub include_categories: Vec<String>,
    pub target_runtime: Option<Vec<String>>,
    pub marker_position: MarkerPosition,
    pub max_payload_length: usize,
}
Expand description

Configuration for payload generation behavior.

§Thread Safety

PayloadConfig is Send and Sync.

Fields§

§max_per_category: usize

Maximum payloads per category before truncation (0 = unlimited).

§deduplicate: bool

Whether to deduplicate identical payloads within a category.

§marker_prefix: String

Default marker prefix for taint tracking (e.g. “SLN”).

§exclude_categories: Vec<String>

Categories to exclude from generation (e.g. for compliance).

§include_categories: Vec<String>

Categories to include exclusively (empty = all).

§target_runtime: Option<Vec<String>>

Restrict loaded grammars to one or more runtimes (empty = all).

§marker_position: MarkerPosition

Where to place the taint marker in generated marker payloads.

§max_payload_length: usize

Maximum length of a single payload in bytes (0 = unlimited).

Implementations§

Source§

impl PayloadConfig

Source

pub fn builder() -> PayloadConfigBuilder

Create a builder for PayloadConfig.

Example:

use attackstr::PayloadConfig;

let config = PayloadConfig::builder().marker_prefix("TRACE").build();
assert_eq!(config.marker_prefix, "TRACE");
Source

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, PayloadError>

Load a PayloadConfig from a TOML file.

Example:

use attackstr::PayloadConfig;

let dir = tempfile::tempdir().unwrap();
let path = dir.path().join("payloads.toml");
std::fs::write(&path, "marker_prefix = \"TRACE\"\n").unwrap();

let config = PayloadConfig::load(&path).unwrap();
assert_eq!(config.marker_prefix, "TRACE");
§Errors

Returns a PayloadError if reading or parsing the file fails.

Source

pub fn from_toml( toml_str: &str, source: impl Into<String>, ) -> Result<Self, PayloadError>

Parse a PayloadConfig directly from TOML text.

Example:

use attackstr::{MarkerPosition, PayloadConfig};

let config = PayloadConfig::from_toml("marker_position = \"suffix\"", "<inline>").unwrap();
assert_eq!(config.marker_position, MarkerPosition::Suffix);
§Errors

Returns a PayloadError if parsing the TOML fails.

Trait Implementations§

Source§

impl Clone for PayloadConfig

Source§

fn clone(&self) -> PayloadConfig

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 PayloadConfig

Source§

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

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

impl Default for PayloadConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for PayloadConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for PayloadConfig

Source§

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

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

impl Eq for PayloadConfig

Source§

impl Hash for PayloadConfig

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PayloadConfig

Source§

fn eq(&self, other: &PayloadConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for PayloadConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PayloadConfig

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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